<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simvoc.core.kernel</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simvoc-module.html">Package&nbsp;simvoc</a> ::
        <a href="simvoc.core-module.html">Package&nbsp;core</a> ::
        Module&nbsp;kernel
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<h1 class="epydoc">Source Code for <a href="simvoc.core.kernel-module.html">Module simvoc.core.kernel</a></h1>
<pre class="py-src">
<a name="L1"></a><tt class="py-lineno">  1</tt>  <tt class="py-line"><tt class="py-comment">#!/usr/bin/env python</tt> </tt>
<a name="L2"></a><tt class="py-lineno">  2</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L3"></a><tt class="py-lineno">  3</tt>  <tt class="py-line"><tt class="py-comment"># The core of the SimVOC simulator: handles processing of discrete events,</tt> </tt>
<a name="L4"></a><tt class="py-lineno">  4</tt>  <tt class="py-line"><tt class="py-comment"># dispatching actions, sending results to output handlers, and basic core</tt> </tt>
<a name="L5"></a><tt class="py-lineno">  5</tt>  <tt class="py-line"><tt class="py-comment"># profiling. This kernel is designed to be reusable and thus has dependencies</tt> </tt>
<a name="L6"></a><tt class="py-lineno">  6</tt>  <tt class="py-line"><tt class="py-comment"># only upon modules from the Python standard library.</tt> </tt>
<a name="L7"></a><tt class="py-lineno">  7</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L8"></a><tt class="py-lineno">  8</tt>  <tt class="py-line"><tt class="py-comment"># Author:   Mike Murphy (mamurph@cs.clemson.edu)</tt> </tt>
<a name="L9"></a><tt class="py-lineno">  9</tt>  <tt class="py-line"><tt class="py-comment"># Revision: 23 September 2009</tt> </tt>
<a name="L10"></a><tt class="py-lineno"> 10</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L11"></a><tt class="py-lineno"> 11</tt>  <tt class="py-line"><tt class="py-comment">#   Copyright 2009 Clemson University</tt> </tt>
<a name="L12"></a><tt class="py-lineno"> 12</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L13"></a><tt class="py-lineno"> 13</tt>  <tt class="py-line"><tt class="py-comment">#   Licensed under the Apache License, Version 2.0 (the "License");</tt> </tt>
<a name="L14"></a><tt class="py-lineno"> 14</tt>  <tt class="py-line"><tt class="py-comment">#   you may not use this file except in compliance with the License.</tt> </tt>
<a name="L15"></a><tt class="py-lineno"> 15</tt>  <tt class="py-line"><tt class="py-comment">#   You may obtain a copy of the License at</tt> </tt>
<a name="L16"></a><tt class="py-lineno"> 16</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L17"></a><tt class="py-lineno"> 17</tt>  <tt class="py-line"><tt class="py-comment">#       http://www.apache.org/licenses/LICENSE-2.0</tt> </tt>
<a name="L18"></a><tt class="py-lineno"> 18</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L19"></a><tt class="py-lineno"> 19</tt>  <tt class="py-line"><tt class="py-comment">#   Unless required by applicable law or agreed to in writing, software</tt> </tt>
<a name="L20"></a><tt class="py-lineno"> 20</tt>  <tt class="py-line"><tt class="py-comment">#   distributed under the License is distributed on an "AS IS" BASIS,</tt> </tt>
<a name="L21"></a><tt class="py-lineno"> 21</tt>  <tt class="py-line"><tt class="py-comment">#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</tt> </tt>
<a name="L22"></a><tt class="py-lineno"> 22</tt>  <tt class="py-line"><tt class="py-comment">#   See the License for the specific language governing permissions and</tt> </tt>
<a name="L23"></a><tt class="py-lineno"> 23</tt>  <tt class="py-line"><tt class="py-comment">#   limitations under the License.</tt> </tt>
<a name="L24"></a><tt class="py-lineno"> 24</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L25"></a><tt class="py-lineno"> 25</tt>  <tt class="py-line"><tt class="py-comment"># This material is based upon work supported under a National Science</tt> </tt>
<a name="L26"></a><tt class="py-lineno"> 26</tt>  <tt class="py-line"><tt class="py-comment"># Foundation Graduate Research Fellowship. Any opinions, findings,</tt> </tt>
<a name="L27"></a><tt class="py-lineno"> 27</tt>  <tt class="py-line"><tt class="py-comment"># conclusions or recommendations expressed in this publication are those of</tt> </tt>
<a name="L28"></a><tt class="py-lineno"> 28</tt>  <tt class="py-line"><tt class="py-comment"># the author(s) and do not necessarily reflect the views of the National</tt> </tt>
<a name="L29"></a><tt class="py-lineno"> 29</tt>  <tt class="py-line"><tt class="py-comment"># Science Foundation.</tt> </tt>
<a name="L30"></a><tt class="py-lineno"> 30</tt>  <tt class="py-line"> </tt>
<a name="L31"></a><tt class="py-lineno"> 31</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L32"></a><tt class="py-lineno"> 32</tt>  <tt class="py-line"><tt class="py-docstring">This module implements the core components of the SimVOC kernel, including</tt> </tt>
<a name="L33"></a><tt class="py-lineno"> 33</tt>  <tt class="py-line"><tt class="py-docstring">the main Simulator class and output handler base class.</tt> </tt>
<a name="L34"></a><tt class="py-lineno"> 34</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L35"></a><tt class="py-lineno"> 35</tt>  <tt class="py-line"><tt class="py-docstring">Application Notes:</tt> </tt>
<a name="L36"></a><tt class="py-lineno"> 36</tt>  <tt class="py-line"><tt class="py-docstring">==================</tt> </tt>
<a name="L37"></a><tt class="py-lineno"> 37</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L38"></a><tt class="py-lineno"> 38</tt>  <tt class="py-line"><tt class="py-docstring">1.  Simulator objects do NOT automatically timestamp results. If event time</tt> </tt>
<a name="L39"></a><tt class="py-lineno"> 39</tt>  <tt class="py-line"><tt class="py-docstring">    is desired in the results, then the return value from the action's</tt> </tt>
<a name="L40"></a><tt class="py-lineno"> 40</tt>  <tt class="py-line"><tt class="py-docstring">    run method should somehow encode the timestamp (e.g. return a string</tt> </tt>
<a name="L41"></a><tt class="py-lineno"> 41</tt>  <tt class="py-line"><tt class="py-docstring">    containing the timestamp).</tt> </tt>
<a name="L42"></a><tt class="py-lineno"> 42</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L43"></a><tt class="py-lineno"> 43</tt>  <tt class="py-line"><tt class="py-docstring">2.  Event functions CAN add new events to the simulation, but the time for</tt> </tt>
<a name="L44"></a><tt class="py-lineno"> 44</tt>  <tt class="py-line"><tt class="py-docstring">    such events must NOT be earlier than the current clock time (i.e. events</tt> </tt>
<a name="L45"></a><tt class="py-lineno"> 45</tt>  <tt class="py-line"><tt class="py-docstring">    cannot be scheduled in the past). A TimeTravelException will occur in</tt> </tt>
<a name="L46"></a><tt class="py-lineno"> 46</tt>  <tt class="py-line"><tt class="py-docstring">    such cases.</tt> </tt>
<a name="L47"></a><tt class="py-lineno"> 47</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L48"></a><tt class="py-lineno"> 48</tt>  <tt class="py-line"><tt class="py-docstring">3.  Multiple events CAN be scheduled to occur at the same time. However, this</tt> </tt>
<a name="L49"></a><tt class="py-lineno"> 49</tt>  <tt class="py-line"><tt class="py-docstring">    simulator is purely sequential: there is no parallel execution of events</tt> </tt>
<a name="L50"></a><tt class="py-lineno"> 50</tt>  <tt class="py-line"><tt class="py-docstring">    that would occur at the same time. Hence, this simulator CANNOT be used</tt> </tt>
<a name="L51"></a><tt class="py-lineno"> 51</tt>  <tt class="py-line"><tt class="py-docstring">    to detect possible race conditions in concurrent operations. Furthermore,</tt> </tt>
<a name="L52"></a><tt class="py-lineno"> 52</tt>  <tt class="py-line"><tt class="py-docstring">    while events are partially ordered with respect to time, there is no</tt> </tt>
<a name="L53"></a><tt class="py-lineno"> 53</tt>  <tt class="py-line"><tt class="py-docstring">    guarantee of activation order when two or more events occur at the same</tt> </tt>
<a name="L54"></a><tt class="py-lineno"> 54</tt>  <tt class="py-line"><tt class="py-docstring">    clock interval.</tt> </tt>
<a name="L55"></a><tt class="py-lineno"> 55</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L56"></a><tt class="py-lineno"> 56</tt>  <tt class="py-line"><tt class="py-docstring">4.  Events fall into two categories: "regular" and "periodic". There is</tt> </tt>
<a name="L57"></a><tt class="py-lineno"> 57</tt>  <tt class="py-line"><tt class="py-docstring">    nothing special about regular events, except that they have their</tt> </tt>
<a name="L58"></a><tt class="py-lineno"> 58</tt>  <tt class="py-line"><tt class="py-docstring">    "keepalive" flags set to True. Periodic events have "keepalive" set to</tt> </tt>
<a name="L59"></a><tt class="py-lineno"> 59</tt>  <tt class="py-line"><tt class="py-docstring">    False, allowing has_regular_events to return False if only periodic events</tt> </tt>
<a name="L60"></a><tt class="py-lineno"> 60</tt>  <tt class="py-line"><tt class="py-docstring">    are left in the queue. This design permits simulator client code to make</tt> </tt>
<a name="L61"></a><tt class="py-lineno"> 61</tt>  <tt class="py-line"><tt class="py-docstring">    calls to has_regular_events to determine if another periodic event should</tt> </tt>
<a name="L62"></a><tt class="py-lineno"> 62</tt>  <tt class="py-line"><tt class="py-docstring">    be scheduled.</tt> </tt>
<a name="L63"></a><tt class="py-lineno"> 63</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L64"></a><tt class="py-lineno"> 64</tt>  <tt class="py-line"><tt class="py-docstring">5.  The simulator stops whenever its event queue becomes empty. Thus, client</tt> </tt>
<a name="L65"></a><tt class="py-lineno"> 65</tt>  <tt class="py-line"><tt class="py-docstring">    code should stop adding events whenever it is ready to terminate.</tt> </tt>
<a name="L66"></a><tt class="py-lineno"> 66</tt>  <tt class="py-line"><tt class="py-docstring">    Unchecked periodic functions that re-schedule themselves WILL result in</tt> </tt>
<a name="L67"></a><tt class="py-lineno"> 67</tt>  <tt class="py-line"><tt class="py-docstring">    infinite simulation runs.</tt> </tt>
<a name="L68"></a><tt class="py-lineno"> 68</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L69"></a><tt class="py-lineno"> 69</tt>  <tt class="py-line"><tt class="py-docstring">6.  Time units are integers or floating-point numbers. The temporal meaning of</tt> </tt>
<a name="L70"></a><tt class="py-lineno"> 70</tt>  <tt class="py-line"><tt class="py-docstring">    a time (e.g. seconds, minutes, etc.) depends on the application.</tt> </tt>
<a name="L71"></a><tt class="py-lineno"> 71</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L72"></a><tt class="py-lineno"> 72</tt>  <tt class="py-line"><tt class="py-docstring">7.  The simulator core is NOT thread-safe. It is intended for use within a</tt> </tt>
<a name="L73"></a><tt class="py-lineno"> 73</tt>  <tt class="py-line"><tt class="py-docstring">    single thread only.</tt> </tt>
<a name="L74"></a><tt class="py-lineno"> 74</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L75"></a><tt class="py-lineno"> 75</tt>  <tt class="py-line"><tt class="py-docstring">8.  If an event returns a *list* or a regular *tuple*, then the list/tuple</tt> </tt>
<a name="L76"></a><tt class="py-lineno"> 76</tt>  <tt class="py-line"><tt class="py-docstring">    will be forwarded whole to the output handler (i.e. there will be a single</tt> </tt>
<a name="L77"></a><tt class="py-lineno"> 77</tt>  <tt class="py-line"><tt class="py-docstring">    result entry containing the entire list/tuple). To return multiple</tt> </tt>
<a name="L78"></a><tt class="py-lineno"> 78</tt>  <tt class="py-line"><tt class="py-docstring">    results (which will be sent to the output object as separate results),</tt> </tt>
<a name="L79"></a><tt class="py-lineno"> 79</tt>  <tt class="py-line"><tt class="py-docstring">    return a 1-tuple containing a list or tuple, e.g. ([1, 2, 3],)</tt> </tt>
<a name="L80"></a><tt class="py-lineno"> 80</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L81"></a><tt class="py-lineno"> 81</tt>  <tt class="py-line"><tt class="py-docstring">9.  The output handler consists of a pipeline containing one or more instances</tt> </tt>
<a name="L82"></a><tt class="py-lineno"> 82</tt>  <tt class="py-line"><tt class="py-docstring">    of the Output class or any of its subclasses. Output data may be filtered</tt> </tt>
<a name="L83"></a><tt class="py-lineno"> 83</tt>  <tt class="py-line"><tt class="py-docstring">    by writing subclasses that perform desired data selection actions.</tt> </tt>
<a name="L84"></a><tt class="py-lineno"> 84</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L85"></a><tt class="py-lineno"> 85</tt>  <tt class="py-line"><tt class="py-docstring">10. Simulator objects provide a random source (using the Python random module)</tt> </tt>
<a name="L86"></a><tt class="py-lineno"> 86</tt>  <tt class="py-line"><tt class="py-docstring">    for use by client code. This random source may be seeded at Simulator</tt> </tt>
<a name="L87"></a><tt class="py-lineno"> 87</tt>  <tt class="py-line"><tt class="py-docstring">    instantiation time, so that simulation results are repeatable.</tt> </tt>
<a name="L88"></a><tt class="py-lineno"> 88</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L89"></a><tt class="py-lineno"> 89</tt>  <tt class="py-line"><tt class="py-docstring">11. The simulator contains an internal debugging mechanism to assist with</tt> </tt>
<a name="L90"></a><tt class="py-lineno"> 90</tt>  <tt class="py-line"><tt class="py-docstring">    client code debugging. This mechanism is by default set to suppress</tt> </tt>
<a name="L91"></a><tt class="py-lineno"> 91</tt>  <tt class="py-line"><tt class="py-docstring">    debugging messages unless and until a large number (default 10,000) of</tt> </tt>
<a name="L92"></a><tt class="py-lineno"> 92</tt>  <tt class="py-line"><tt class="py-docstring">    consecutive event loop iterations occur, in which only periodic events</tt> </tt>
<a name="L93"></a><tt class="py-lineno"> 93</tt>  <tt class="py-line"><tt class="py-docstring">    are found in the queue. Since automatic detection of infinite simulations</tt> </tt>
<a name="L94"></a><tt class="py-lineno"> 94</tt>  <tt class="py-line"><tt class="py-docstring">    is not possible (halting problem), this heuristic may be adjusted or</tt> </tt>
<a name="L95"></a><tt class="py-lineno"> 95</tt>  <tt class="py-line"><tt class="py-docstring">    disabled as desired.</tt> </tt>
<a name="L96"></a><tt class="py-lineno"> 96</tt>  <tt class="py-line"><tt class="py-docstring">'''</tt> </tt>
<a name="L97"></a><tt class="py-lineno"> 97</tt>  <tt class="py-line"> </tt>
<a name="L98"></a><tt class="py-lineno"> 98</tt>  <tt class="py-line"><tt class="py-keyword">import</tt> <tt class="py-name">heapq</tt><tt class="py-op">,</tt> <tt class="py-name">os</tt><tt class="py-op">,</tt> <tt class="py-name">random</tt><tt class="py-op">,</tt> <tt class="py-name">sys</tt><tt class="py-op">,</tt> <tt class="py-name">time</tt> </tt>
<a name="L99"></a><tt class="py-lineno"> 99</tt>  <tt class="py-line"> </tt>
<a name="L100"></a><tt class="py-lineno">100</tt>  <tt class="py-line"> </tt>
<a name="L101"></a><tt class="py-lineno">101</tt>  <tt class="py-line"><tt class="py-comment"># Utility functions to make dictionaries out of trace and metadata kernel</tt> </tt>
<a name="L102"></a><tt class="py-lineno">102</tt>  <tt class="py-line"><tt class="py-comment"># events. Simulation systems may want to replace these functions as desired.</tt> </tt>
<a name="kernel_trace"></a><div id="kernel_trace-def"><a name="L103"></a><tt class="py-lineno">103</tt> <a class="py-toggle" href="#" id="kernel_trace-toggle" onclick="return toggle('kernel_trace');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel-module.html#kernel_trace">kernel_trace</a><tt class="py-op">(</tt><tt class="py-param">simtime</tt><tt class="py-op">,</tt> <tt class="py-param">realtime</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">,</tt> <tt class="py-param">qsize</tt><tt class="py-op">,</tt> <tt class="py-param">events</tt><tt class="py-op">,</tt> <tt class="py-param">rate</tt><tt class="py-op">,</tt> <tt class="py-param">de</tt><tt class="py-op">,</tt> <tt class="py-param">dq</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="kernel_trace-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="kernel_trace-expanded"><a name="L104"></a><tt class="py-lineno">104</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L105"></a><tt class="py-lineno">105</tt>  <tt class="py-line"><tt class="py-docstring">   Base function that produces a dictionary with kernel trace data (time,</tt> </tt>
<a name="L106"></a><tt class="py-lineno">106</tt>  <tt class="py-line"><tt class="py-docstring">   queue size, event counts, etc.) at each kernel update interval. This</tt> </tt>
<a name="L107"></a><tt class="py-lineno">107</tt>  <tt class="py-line"><tt class="py-docstring">   function may be replaced by simulation system client code as desired.</tt> </tt>
<a name="L108"></a><tt class="py-lineno">108</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L109"></a><tt class="py-lineno">109</tt>  <tt class="py-line"><tt class="py-docstring">   @param simtime: Current simulated time</tt> </tt>
<a name="L110"></a><tt class="py-lineno">110</tt>  <tt class="py-line"><tt class="py-docstring">   @type simtime: number</tt> </tt>
<a name="L111"></a><tt class="py-lineno">111</tt>  <tt class="py-line"><tt class="py-docstring">   @param realtime: Current wall clock time in UTC seconds since the epoch</tt> </tt>
<a name="L112"></a><tt class="py-lineno">112</tt>  <tt class="py-line"><tt class="py-docstring">   @type realtime: float</tt> </tt>
<a name="L113"></a><tt class="py-lineno">113</tt>  <tt class="py-line"><tt class="py-docstring">   @param msg: Current simulator message</tt> </tt>
<a name="L114"></a><tt class="py-lineno">114</tt>  <tt class="py-line"><tt class="py-docstring">   @type msg: str</tt> </tt>
<a name="L115"></a><tt class="py-lineno">115</tt>  <tt class="py-line"><tt class="py-docstring">   @param qsize: Current event queue size</tt> </tt>
<a name="L116"></a><tt class="py-lineno">116</tt>  <tt class="py-line"><tt class="py-docstring">   @type qsize: int</tt> </tt>
<a name="L117"></a><tt class="py-lineno">117</tt>  <tt class="py-line"><tt class="py-docstring">   @param events: Total number of events processed</tt> </tt>
<a name="L118"></a><tt class="py-lineno">118</tt>  <tt class="py-line"><tt class="py-docstring">   @type events: int</tt> </tt>
<a name="L119"></a><tt class="py-lineno">119</tt>  <tt class="py-line"><tt class="py-docstring">   @param rate: Event processing rate (events/sec)</tt> </tt>
<a name="L120"></a><tt class="py-lineno">120</tt>  <tt class="py-line"><tt class="py-docstring">   @type rate: float</tt> </tt>
<a name="L121"></a><tt class="py-lineno">121</tt>  <tt class="py-line"><tt class="py-docstring">   @param de: Number of events processed since last trace update</tt> </tt>
<a name="L122"></a><tt class="py-lineno">122</tt>  <tt class="py-line"><tt class="py-docstring">   @type de: int</tt> </tt>
<a name="L123"></a><tt class="py-lineno">123</tt>  <tt class="py-line"><tt class="py-docstring">   @param dq: Change in event queue size since last trace update</tt> </tt>
<a name="L124"></a><tt class="py-lineno">124</tt>  <tt class="py-line"><tt class="py-docstring">   @type dq: int</tt> </tt>
<a name="L125"></a><tt class="py-lineno">125</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L126"></a><tt class="py-lineno">126</tt>  <tt class="py-line"><tt class="py-docstring">   @rtype: dict</tt> </tt>
<a name="L127"></a><tt class="py-lineno">127</tt>  <tt class="py-line"><tt class="py-docstring">   @return: dictionary containing trace information</tt> </tt>
<a name="L128"></a><tt class="py-lineno">128</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="L129"></a><tt class="py-lineno">129</tt>  <tt class="py-line">   <tt class="py-name">r</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-string">'simulated_time'</tt><tt class="py-op">:</tt> <tt class="py-name">simtime</tt><tt class="py-op">,</tt> <tt class="py-string">'real_time'</tt><tt class="py-op">:</tt> <tt class="py-name">realtime</tt><tt class="py-op">,</tt> <tt class="py-string">'message'</tt><tt class="py-op">:</tt> <tt class="py-name">msg</tt><tt class="py-op">,</tt> \ </tt>
<a name="L130"></a><tt class="py-lineno">130</tt>  <tt class="py-line">         <tt class="py-string">'queue_size'</tt><tt class="py-op">:</tt> <tt class="py-name">qsize</tt><tt class="py-op">,</tt> <tt class="py-string">'events_processed'</tt><tt class="py-op">:</tt> <tt class="py-name">events</tt><tt class="py-op">,</tt> <tt class="py-string">'event_rate'</tt><tt class="py-op">:</tt> <tt class="py-name">rate</tt><tt class="py-op">,</tt> \ </tt>
<a name="L131"></a><tt class="py-lineno">131</tt>  <tt class="py-line">         <tt class="py-string">'delta_e'</tt><tt class="py-op">:</tt> <tt class="py-name">de</tt><tt class="py-op">,</tt> <tt class="py-string">'delta_q'</tt><tt class="py-op">:</tt> <tt class="py-name">dq</tt> <tt class="py-op">}</tt> </tt>
<a name="L132"></a><tt class="py-lineno">132</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-name">r</tt> </tt>
</div><a name="L133"></a><tt class="py-lineno">133</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L134"></a><tt class="py-lineno">134</tt>  <tt class="py-line"> </tt>
<a name="kernel_metadata"></a><div id="kernel_metadata-def"><a name="L135"></a><tt class="py-lineno">135</tt> <a class="py-toggle" href="#" id="kernel_metadata-toggle" onclick="return toggle('kernel_metadata');">-</a><tt class="py-line"><tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel-module.html#kernel_metadata">kernel_metadata</a><tt class="py-op">(</tt><tt class="py-param">start_time</tt><tt class="py-op">,</tt> <tt class="py-param">end_time</tt><tt class="py-op">,</tt> <tt class="py-param">exec_time</tt><tt class="py-op">,</tt> <tt class="py-param">event_count</tt><tt class="py-op">,</tt> <tt class="py-param">event_rate</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="kernel_metadata-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="kernel_metadata-expanded"><a name="L136"></a><tt class="py-lineno">136</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L137"></a><tt class="py-lineno">137</tt>  <tt class="py-line"><tt class="py-docstring">   Base function that creates a metadata dictionary at the end of a simulation</tt> </tt>
<a name="L138"></a><tt class="py-lineno">138</tt>  <tt class="py-line"><tt class="py-docstring">   run. Client code may replace this function if desired.</tt> </tt>
<a name="L139"></a><tt class="py-lineno">139</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L140"></a><tt class="py-lineno">140</tt>  <tt class="py-line"><tt class="py-docstring">   @param start_time: Simulation start time in UTC seconds since epoch</tt> </tt>
<a name="L141"></a><tt class="py-lineno">141</tt>  <tt class="py-line"><tt class="py-docstring">   @type start_time: float</tt> </tt>
<a name="L142"></a><tt class="py-lineno">142</tt>  <tt class="py-line"><tt class="py-docstring">   @param end_time: Simulation end time in UTC seconds since epoch</tt> </tt>
<a name="L143"></a><tt class="py-lineno">143</tt>  <tt class="py-line"><tt class="py-docstring">   @type end_time: float</tt> </tt>
<a name="L144"></a><tt class="py-lineno">144</tt>  <tt class="py-line"><tt class="py-docstring">   @param exec_time:  Execution time (seconds) for the simulation</tt> </tt>
<a name="L145"></a><tt class="py-lineno">145</tt>  <tt class="py-line"><tt class="py-docstring">   @type exec_time: float</tt> </tt>
<a name="L146"></a><tt class="py-lineno">146</tt>  <tt class="py-line"><tt class="py-docstring">   @param event_count: Total number of events processed during the run</tt> </tt>
<a name="L147"></a><tt class="py-lineno">147</tt>  <tt class="py-line"><tt class="py-docstring">   @type event_count: int</tt> </tt>
<a name="L148"></a><tt class="py-lineno">148</tt>  <tt class="py-line"><tt class="py-docstring">   @param event_rate: Average event processing rate over the run</tt> </tt>
<a name="L149"></a><tt class="py-lineno">149</tt>  <tt class="py-line"><tt class="py-docstring">   @type event_rate: float</tt> </tt>
<a name="L150"></a><tt class="py-lineno">150</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L151"></a><tt class="py-lineno">151</tt>  <tt class="py-line"><tt class="py-docstring">   @rtype: dict</tt> </tt>
<a name="L152"></a><tt class="py-lineno">152</tt>  <tt class="py-line"><tt class="py-docstring">   @return: dictionary containing simulator metadata</tt> </tt>
<a name="L153"></a><tt class="py-lineno">153</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="L154"></a><tt class="py-lineno">154</tt>  <tt class="py-line">   <tt class="py-name">r</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt> <tt class="py-string">'run_start_time'</tt><tt class="py-op">:</tt> <tt class="py-name">start_time</tt><tt class="py-op">,</tt> <tt class="py-string">'run_end_time'</tt><tt class="py-op">:</tt> <tt class="py-name">end_time</tt><tt class="py-op">,</tt> \ </tt>
<a name="L155"></a><tt class="py-lineno">155</tt>  <tt class="py-line">         <tt class="py-string">'sim_exec_time'</tt><tt class="py-op">:</tt> <tt class="py-name">exec_time</tt><tt class="py-op">,</tt> <tt class="py-string">'sim_total_events'</tt><tt class="py-op">:</tt> <tt class="py-name">event_count</tt><tt class="py-op">,</tt> \ </tt>
<a name="L156"></a><tt class="py-lineno">156</tt>  <tt class="py-line">         <tt class="py-string">'sim_event_rate'</tt><tt class="py-op">:</tt> <tt class="py-name">event_rate</tt><tt class="py-op">,</tt> <tt class="py-string">'version'</tt><tt class="py-op">:</tt> <tt class="py-name">end_time</tt> <tt class="py-op">}</tt> </tt>
<a name="L157"></a><tt class="py-lineno">157</tt>  <tt class="py-line">   <tt class="py-keyword">return</tt> <tt class="py-name">r</tt> </tt>
</div><a name="L158"></a><tt class="py-lineno">158</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L159"></a><tt class="py-lineno">159</tt>  <tt class="py-line"> </tt>
<a name="L160"></a><tt class="py-lineno">160</tt>  <tt class="py-line"> </tt>
<a name="TimeTravelException"></a><div id="TimeTravelException-def"><a name="L161"></a><tt class="py-lineno">161</tt> <a class="py-toggle" href="#" id="TimeTravelException-toggle" onclick="return toggle('TimeTravelException');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.kernel.TimeTravelException-class.html">TimeTravelException</a><tt class="py-op">(</tt><tt class="py-base-class">Exception</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="TimeTravelException-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="TimeTravelException-expanded"><a name="L162"></a><tt class="py-lineno">162</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L163"></a><tt class="py-lineno">163</tt>  <tt class="py-line"><tt class="py-docstring">   Exception raised when attempting to schedule an event in the past</tt> </tt>
<a name="L164"></a><tt class="py-lineno">164</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="L165"></a><tt class="py-lineno">165</tt>  <tt class="py-line">   <tt class="py-keyword">pass</tt> </tt>
</div><a name="L166"></a><tt class="py-lineno">166</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L167"></a><tt class="py-lineno">167</tt>  <tt class="py-line"> </tt>
<a name="L168"></a><tt class="py-lineno">168</tt>  <tt class="py-line"> </tt>
<a name="Output"></a><div id="Output-def"><a name="L169"></a><tt class="py-lineno">169</tt> <a class="py-toggle" href="#" id="Output-toggle" onclick="return toggle('Output');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.kernel.Output-class.html">Output</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Output-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Output-expanded"><a name="L170"></a><tt class="py-lineno">170</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L171"></a><tt class="py-lineno">171</tt>  <tt class="py-line"><tt class="py-docstring">   Simulator output handler base class. Output handlers may be chained</tt> </tt>
<a name="L172"></a><tt class="py-lineno">172</tt>  <tt class="py-line"><tt class="py-docstring">   together to form a pipeline for filtering, writing to multiple</tt> </tt>
<a name="L173"></a><tt class="py-lineno">173</tt>  <tt class="py-line"><tt class="py-docstring">   destinations, etc.</tt> </tt>
<a name="L174"></a><tt class="py-lineno">174</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L175"></a><tt class="py-lineno">175</tt>  <tt class="py-line"><tt class="py-docstring">   The simulator only calls the append() and close() methods of the FIRST</tt> </tt>
<a name="L176"></a><tt class="py-lineno">176</tt>  <tt class="py-line"><tt class="py-docstring">   Output instance in the pipeline. Thus, all implementations of close()</tt> </tt>
<a name="L177"></a><tt class="py-lineno">177</tt>  <tt class="py-line"><tt class="py-docstring">   should call the close() method of any downstream Output instance.</tt> </tt>
<a name="L178"></a><tt class="py-lineno">178</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L179"></a><tt class="py-lineno">179</tt>  <tt class="py-line"><tt class="py-docstring">   This base implementation output handler does nothing with the output</tt> </tt>
<a name="L180"></a><tt class="py-lineno">180</tt>  <tt class="py-line"><tt class="py-docstring">   (except to pass it to another Output class, if configured to do so). See</tt> </tt>
<a name="L181"></a><tt class="py-lineno">181</tt>  <tt class="py-line"><tt class="py-docstring">   the StreamOutput class (below) for a simple implementation that actually</tt> </tt>
<a name="L182"></a><tt class="py-lineno">182</tt>  <tt class="py-line"><tt class="py-docstring">   does something.</tt> </tt>
<a name="L183"></a><tt class="py-lineno">183</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="Output.__init__"></a><div id="Output.__init__-def"><a name="L184"></a><tt class="py-lineno">184</tt> <a class="py-toggle" href="#" id="Output.__init__-toggle" onclick="return toggle('Output.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Output-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">output</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Output.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Output.__init__-expanded"><a name="L185"></a><tt class="py-lineno">185</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L186"></a><tt class="py-lineno">186</tt>  <tt class="py-line"><tt class="py-docstring">      @param output: Optional downstream Output instance to which the result</tt> </tt>
<a name="L187"></a><tt class="py-lineno">187</tt>  <tt class="py-line"><tt class="py-docstring">                     will be passed</tt> </tt>
<a name="L188"></a><tt class="py-lineno">188</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L189"></a><tt class="py-lineno">189</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">output_handler</tt> <tt class="py-op">=</tt> <tt class="py-name">output</tt> </tt>
</div><a name="Output.handle_append"></a><div id="Output.handle_append-def"><a name="L190"></a><tt class="py-lineno">190</tt> <a class="py-toggle" href="#" id="Output.handle_append-toggle" onclick="return toggle('Output.handle_append');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Output-class.html#handle_append">handle_append</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">result</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Output.handle_append-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Output.handle_append-expanded"><a name="L191"></a><tt class="py-lineno">191</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L192"></a><tt class="py-lineno">192</tt>  <tt class="py-line"><tt class="py-docstring">      Subclasses should override this method to implement the actual handling</tt> </tt>
<a name="L193"></a><tt class="py-lineno">193</tt>  <tt class="py-line"><tt class="py-docstring">      of output. This implementation does nothing.</tt> </tt>
<a name="L194"></a><tt class="py-lineno">194</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L195"></a><tt class="py-lineno">195</tt>  <tt class="py-line"><tt class="py-docstring">      @param result: Result to add to the output</tt> </tt>
<a name="L196"></a><tt class="py-lineno">196</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L197"></a><tt class="py-lineno">197</tt>  <tt class="py-line">      <tt class="py-keyword">pass</tt> </tt>
</div><a name="Output.append"></a><div id="Output.append-def"><a name="L198"></a><tt class="py-lineno">198</tt> <a class="py-toggle" href="#" id="Output.append-toggle" onclick="return toggle('Output.append');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Output-class.html#append">append</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">result</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Output.append-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Output.append-expanded"><a name="L199"></a><tt class="py-lineno">199</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L200"></a><tt class="py-lineno">200</tt>  <tt class="py-line"><tt class="py-docstring">      Appends a result to the output destination, then passes the result to</tt> </tt>
<a name="L201"></a><tt class="py-lineno">201</tt>  <tt class="py-line"><tt class="py-docstring">      a downstream Output handler, if any.</tt> </tt>
<a name="L202"></a><tt class="py-lineno">202</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L203"></a><tt class="py-lineno">203</tt>  <tt class="py-line"><tt class="py-docstring">      @param result: Result to add to the output</tt> </tt>
<a name="L204"></a><tt class="py-lineno">204</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L205"></a><tt class="py-lineno">205</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-0" class="py-name" targets="Method simvoc.core.aggregator.Aggregator.handle_append()=simvoc.core.aggregator.Aggregator-class.html#handle_append,Method simvoc.core.db_output.DBOutput.handle_append()=simvoc.core.db_output.DBOutput-class.html#handle_append,Method simvoc.core.duplicate_filter.DuplicateFilter.handle_append()=simvoc.core.duplicate_filter.DuplicateFilter-class.html#handle_append,Method simvoc.core.filter_results.ResultFilter.handle_append()=simvoc.core.filter_results.ResultFilter-class.html#handle_append,Method simvoc.core.kernel.Output.handle_append()=simvoc.core.kernel.Output-class.html#handle_append,Method simvoc.core.kernel.StreamOutput.handle_append()=simvoc.core.kernel.StreamOutput-class.html#handle_append"><a title="simvoc.core.aggregator.Aggregator.handle_append
simvoc.core.db_output.DBOutput.handle_append
simvoc.core.duplicate_filter.DuplicateFilter.handle_append
simvoc.core.filter_results.ResultFilter.handle_append
simvoc.core.kernel.Output.handle_append
simvoc.core.kernel.StreamOutput.handle_append" class="py-name" href="#" onclick="return doclink('link-0', 'handle_append', 'link-0');">handle_append</a></tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
<a name="L206"></a><tt class="py-lineno">206</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">output_handler</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L207"></a><tt class="py-lineno">207</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">output_handler</tt><tt class="py-op">.</tt><tt id="link-1" class="py-name" targets="Method simvoc.core.duplicate_filter.DuplicateFilter.append()=simvoc.core.duplicate_filter.DuplicateFilter-class.html#append,Method simvoc.core.filter_results.ResultFilter.append()=simvoc.core.filter_results.ResultFilter-class.html#append,Method simvoc.core.kernel.Output.append()=simvoc.core.kernel.Output-class.html#append"><a title="simvoc.core.duplicate_filter.DuplicateFilter.append
simvoc.core.filter_results.ResultFilter.append
simvoc.core.kernel.Output.append" class="py-name" href="#" onclick="return doclink('link-1', 'append', 'link-1');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
</div><a name="Output.handle_close"></a><div id="Output.handle_close-def"><a name="L208"></a><tt class="py-lineno">208</tt> <a class="py-toggle" href="#" id="Output.handle_close-toggle" onclick="return toggle('Output.handle_close');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Output-class.html#handle_close">handle_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Output.handle_close-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Output.handle_close-expanded"><a name="L209"></a><tt class="py-lineno">209</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L210"></a><tt class="py-lineno">210</tt>  <tt class="py-line"><tt class="py-docstring">      Subclasses should override this method to implement the actual closing</tt> </tt>
<a name="L211"></a><tt class="py-lineno">211</tt>  <tt class="py-line"><tt class="py-docstring">      of an output destination. This implementation does nothing</tt> </tt>
<a name="L212"></a><tt class="py-lineno">212</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L213"></a><tt class="py-lineno">213</tt>  <tt class="py-line">      <tt class="py-keyword">pass</tt> </tt>
</div><a name="Output.close"></a><div id="Output.close-def"><a name="L214"></a><tt class="py-lineno">214</tt> <a class="py-toggle" href="#" id="Output.close-toggle" onclick="return toggle('Output.close');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Output-class.html#close">close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Output.close-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Output.close-expanded"><a name="L215"></a><tt class="py-lineno">215</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L216"></a><tt class="py-lineno">216</tt>  <tt class="py-line"><tt class="py-docstring">      Closes all output handlers in the downstream portion of the pipeline,</tt> </tt>
<a name="L217"></a><tt class="py-lineno">217</tt>  <tt class="py-line"><tt class="py-docstring">      including the output handler on which this method is invoked (if</tt> </tt>
<a name="L218"></a><tt class="py-lineno">218</tt>  <tt class="py-line"><tt class="py-docstring">      applicable).</tt> </tt>
<a name="L219"></a><tt class="py-lineno">219</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L220"></a><tt class="py-lineno">220</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-2" class="py-name" targets="Method simvoc.core.aggregator.Aggregator.handle_close()=simvoc.core.aggregator.Aggregator-class.html#handle_close,Method simvoc.core.db_output.DBOutput.handle_close()=simvoc.core.db_output.DBOutput-class.html#handle_close,Method simvoc.core.duplicate_filter.DuplicateFilter.handle_close()=simvoc.core.duplicate_filter.DuplicateFilter-class.html#handle_close,Method simvoc.core.filter_results.ResultFilter.handle_close()=simvoc.core.filter_results.ResultFilter-class.html#handle_close,Method simvoc.core.kernel.Output.handle_close()=simvoc.core.kernel.Output-class.html#handle_close,Method simvoc.core.kernel.StreamOutput.handle_close()=simvoc.core.kernel.StreamOutput-class.html#handle_close"><a title="simvoc.core.aggregator.Aggregator.handle_close
simvoc.core.db_output.DBOutput.handle_close
simvoc.core.duplicate_filter.DuplicateFilter.handle_close
simvoc.core.filter_results.ResultFilter.handle_close
simvoc.core.kernel.Output.handle_close
simvoc.core.kernel.StreamOutput.handle_close" class="py-name" href="#" onclick="return doclink('link-2', 'handle_close', 'link-2');">handle_close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L221"></a><tt class="py-lineno">221</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">output_handler</tt> <tt class="py-keyword">is</tt> <tt class="py-keyword">not</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L222"></a><tt class="py-lineno">222</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">output_handler</tt><tt class="py-op">.</tt><tt id="link-3" class="py-name" targets="Method simvoc.core.duplicate_filter.DuplicateFilter.close()=simvoc.core.duplicate_filter.DuplicateFilter-class.html#close,Method simvoc.core.filter_results.ResultFilter.close()=simvoc.core.filter_results.ResultFilter-class.html#close,Method simvoc.core.input_manager.FlexInput.close()=simvoc.core.input_manager.FlexInput-class.html#close,Method simvoc.core.kernel.Output.close()=simvoc.core.kernel.Output-class.html#close"><a title="simvoc.core.duplicate_filter.DuplicateFilter.close
simvoc.core.filter_results.ResultFilter.close
simvoc.core.input_manager.FlexInput.close
simvoc.core.kernel.Output.close" class="py-name" href="#" onclick="return doclink('link-3', 'close', 'link-3');">close</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L223"></a><tt class="py-lineno">223</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L224"></a><tt class="py-lineno">224</tt>  <tt class="py-line"> </tt>
<a name="StreamOutput"></a><div id="StreamOutput-def"><a name="L225"></a><tt class="py-lineno">225</tt> <a class="py-toggle" href="#" id="StreamOutput-toggle" onclick="return toggle('StreamOutput');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.kernel.StreamOutput-class.html">StreamOutput</a><tt class="py-op">(</tt><tt class="py-base-class">Output</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="StreamOutput-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="StreamOutput-expanded"><a name="L226"></a><tt class="py-lineno">226</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L227"></a><tt class="py-lineno">227</tt>  <tt class="py-line"><tt class="py-docstring">   Writes output to a file-like object (default is sys.stdout). Note that</tt> </tt>
<a name="L228"></a><tt class="py-lineno">228</tt>  <tt class="py-line"><tt class="py-docstring">   the stream is NOT closed when calling the close() method!</tt> </tt>
<a name="L229"></a><tt class="py-lineno">229</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="StreamOutput.__init__"></a><div id="StreamOutput.__init__-def"><a name="L230"></a><tt class="py-lineno">230</tt> <a class="py-toggle" href="#" id="StreamOutput.__init__-toggle" onclick="return toggle('StreamOutput.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.StreamOutput-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">fh</tt><tt class="py-op">=</tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">,</tt> <tt class="py-param">output</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="StreamOutput.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="StreamOutput.__init__-expanded"><a name="L231"></a><tt class="py-lineno">231</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L232"></a><tt class="py-lineno">232</tt>  <tt class="py-line"><tt class="py-docstring">      @param fh: Open file-like object (w mode) to which results are written</tt> </tt>
<a name="L233"></a><tt class="py-lineno">233</tt>  <tt class="py-line"><tt class="py-docstring">      @param output: Optional downstream Output object for pipeline use</tt> </tt>
<a name="L234"></a><tt class="py-lineno">234</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L235"></a><tt class="py-lineno">235</tt>  <tt class="py-line">      <tt id="link-4" class="py-name" targets="Class simvoc.core.kernel.Output=simvoc.core.kernel.Output-class.html"><a title="simvoc.core.kernel.Output" class="py-name" href="#" onclick="return doclink('link-4', 'Output', 'link-4');">Output</a></tt><tt class="py-op">.</tt><tt id="link-5" class="py-name" targets="Method simvoc.core.aggregator.Aggregator.__init__()=simvoc.core.aggregator.Aggregator-class.html#__init__,Method simvoc.core.ce_sim.Site.__init__()=simvoc.core.ce_sim.Site-class.html#__init__,Method simvoc.core.cluster_sim.Cluster.__init__()=simvoc.core.cluster_sim.Cluster-class.html#__init__,Method simvoc.core.cluster_sim.Machine.__init__()=simvoc.core.cluster_sim.Machine-class.html#__init__,Method simvoc.core.cluster_sim.MachineFactory.__init__()=simvoc.core.cluster_sim.MachineFactory-class.html#__init__,Method simvoc.core.common_reader.CommonReader.__init__()=simvoc.core.common_reader.CommonReader-class.html#__init__,Method simvoc.core.condor_sim.Condor.__init__()=simvoc.core.condor_sim.Condor-class.html#__init__,Method simvoc.core.control_scheduler.ControlScheduler.__init__()=simvoc.core.control_scheduler.ControlScheduler-class.html#__init__,Method simvoc.core.db_output.DBOutput.__init__()=simvoc.core.db_output.DBOutput-class.html#__init__,Method simvoc.core.duplicate_filter.DuplicateFilter.__init__()=simvoc.core.duplicate_filter.DuplicateFilter-class.html#__init__,Method simvoc.core.filter_results.ResultFilter.__init__()=simvoc.core.filter_results.ResultFilter-class.html#__init__,Method simvoc.core.grid_sim.Grid.__init__()=simvoc.core.grid_sim.Grid-class.html#__init__,Method simvoc.core.input_manager.FlexInput.__init__()=simvoc.core.input_manager.FlexInput-class.html#__init__,Method simvoc.core.job_format_reader.JobReader.__init__()=simvoc.core.job_format_reader.JobReader-class.html#__init__,Method simvoc.core.job_model.Job.__init__()=simvoc.core.job_model.Job-class.html#__init__,Method simvoc.core.job_model.PilotJob.__init__()=simvoc.core.job_model.PilotJob-class.html#__init__,Method simvoc.core.kernel.Event.__init__()=simvoc.core.kernel.Event-class.html#__init__,Method simvoc.core.kernel.EventQueue.__init__()=simvoc.core.kernel.EventQueue-class.html#__init__,Method simvoc.core.kernel.Output.__init__()=simvoc.core.kernel.Output-class.html#__init__,Method simvoc.core.kernel.Simulator.__init__()=simvoc.core.kernel.Simulator-class.html#__init__,Method simvoc.core.kernel.StreamOutput.__init__()=simvoc.core.kernel.StreamOutput-class.html#__init__,Method simvoc.core.map_format_reader.MapReader.__init__()=simvoc.core.map_format_reader.MapReader-class.html#__init__,Method simvoc.core.metascheduler.Metascheduler.__init__()=simvoc.core.metascheduler.Metascheduler-class.html#__init__,Method simvoc.core.results.AggregationResult.__init__()=simvoc.core.results.AggregationResult-class.html#__init__,Method simvoc.core.results.DiscardResult.__init__()=simvoc.core.results.DiscardResult-class.html#__init__,Method simvoc.core.results.DiscrepancyResult.__init__()=simvoc.core.results.DiscrepancyResult-class.html#__init__,Method simvoc.core.results.FileRequestResult.__init__()=simvoc.core.results.FileRequestResult-class.html#__init__,Method simvoc.core.results.FileTransferResult.__init__()=simvoc.core.results.FileTransferResult-class.html#__init__,Method simvoc.core.results.JobResult.__init__()=simvoc.core.results.JobResult-class.html#__init__,Method simvoc.core.results.JobStartResult.__init__()=simvoc.core.results.JobStartResult-class.html#__init__,Method simvoc.core.results.JobSubmitResult.__init__()=simvoc.core.results.JobSubmitResult-class.html#__init__,Method simvoc.core.results.MetadataResult.__init__()=simvoc.core.results.MetadataResult-class.html#__init__,Method simvoc.core.results.Result.__init__()=simvoc.core.results.Result-class.html#__init__,Method simvoc.core.results.SchedResult.__init__()=simvoc.core.results.SchedResult-class.html#__init__,Method simvoc.core.results.SiteRejectionResult.__init__()=simvoc.core.results.SiteRejectionResult-class.html#__init__,Method simvoc.core.results.SiteResult.__init__()=simvoc.core.results.SiteResult-class.html#__init__,Method simvoc.core.results.TraceResult.__init__()=simvoc.core.results.TraceResult-class.html#__init__,Method simvoc.core.results.VMPilotResult.__init__()=simvoc.core.results.VMPilotResult-class.html#__init__,Method simvoc.core.results.VMResult.__init__()=simvoc.core.results.VMResult-class.html#__init__,Method simvoc.core.results.VOCResult.__init__()=simvoc.core.results.VOCResult-class.html#__init__,Method simvoc.core.results.VOResult.__init__()=simvoc.core.results.VOResult-class.html#__init__,Method simvoc.core.results.WatchdogResult.__init__()=simvoc.core.results.WatchdogResult-class.html#__init__,Method simvoc.core.scheduler.Scheduler.__init__()=simvoc.core.scheduler.Scheduler-class.html#__init__,Method simvoc.core.storage.DataFile.__init__()=simvoc.core.storage.DataFile-class.html#__init__,Method simvoc.core.storage.FileCache.__init__()=simvoc.core.storage.FileCache-class.html#__init__,Method simvoc.core.storage.FileStore.__init__()=simvoc.core.storage.FileStore-class.html#__init__,Method simvoc.core.virtualization.VMHost.__init__()=simvoc.core.virtualization.VMHost-class.html#__init__,Method simvoc.core.virtualization.VMImage.__init__()=simvoc.core.virtualization.VMImage-class.html#__init__,Method simvoc.core.virtualization.VMMonitor.__init__()=simvoc.core.virtualization.VMMonitor-class.html#__init__,Method simvoc.core.virtualization.VirtualMachine.__init__()=simvoc.core.virtualization.VirtualMachine-class.html#__init__,Method simvoc.core.vo_format_reader.VO.__init__()=simvoc.core.vo_format_reader.VO-class.html#__init__,Method simvoc.core.vo_format_reader.VOReader.__init__()=simvoc.core.vo_format_reader.VOReader-class.html#__init__,Method simvoc.core.voc_sim.AutoVOC.__init__()=simvoc.core.voc_sim.AutoVOC-class.html#__init__,Method simvoc.core.voc_sim.VMPilot.__init__()=simvoc.core.voc_sim.VMPilot-class.html#__init__,Method simvoc.core.voc_sim.VOC.__init__()=simvoc.core.voc_sim.VOC-class.html#__init__,Method simvoc.core.watchdog_sim.WatchRecord.__init__()=simvoc.core.watchdog_sim.WatchRecord-class.html#__init__,Method simvoc.core.watchdog_sim.Watchdog.__init__()=simvoc.core.watchdog_sim.Watchdog-class.html#__init__,Method simvoc.input.common_writer.CommonWriter.__init__()=simvoc.input.common_writer.CommonWriter-class.html#__init__,Method simvoc.input.data_input.Data.__init__()=simvoc.input.data_input.Data-class.html#__init__,Method simvoc.input.egee_map_input.EGEEMap.__init__()=simvoc.input.egee_map_input.EGEEMap-class.html#__init__,Method simvoc.input.egee_map_input.SiteParser.__init__()=simvoc.input.egee_map_input.SiteParser-class.html#__init__,Method simvoc.input.egee_rtm_input.JobTrace.__init__()=simvoc.input.egee_rtm_input.JobTrace-class.html#__init__,Method simvoc.input.flat_data_input.FlatData.__init__()=simvoc.input.flat_data_input.FlatData-class.html#__init__,Method simvoc.input.job_format_writer.JobWriter.__init__()=simvoc.input.job_format_writer.JobWriter-class.html#__init__,Method simvoc.input.map_format_writer.MapWriter.__init__()=simvoc.input.map_format_writer.MapWriter-class.html#__init__,Method simvoc.input.mod_ldif.LDIFCopy.__init__()=simvoc.input.mod_ldif.LDIFCopy-class.html#__init__,Method simvoc.input.mod_ldif.LDIFParser.__init__()=simvoc.input.mod_ldif.LDIFParser-class.html#__init__,Method simvoc.input.mod_ldif.LDIFRecordList.__init__()=simvoc.input.mod_ldif.LDIFRecordList-class.html#__init__,Method simvoc.input.mod_ldif.LDIFWriter.__init__()=simvoc.input.mod_ldif.LDIFWriter-class.html#__init__,Method simvoc.input.tabbed_data_input.TabbedData.__init__()=simvoc.input.tabbed_data_input.TabbedData-class.html#__init__,Method simvoc.input.vo_format_writer.VOWriter.__init__()=simvoc.input.vo_format_writer.VOWriter-class.html#__init__"><a title="simvoc.core.aggregator.Aggregator.__init__
simvoc.core.ce_sim.Site.__init__
simvoc.core.cluster_sim.Cluster.__init__
simvoc.core.cluster_sim.Machine.__init__
simvoc.core.cluster_sim.MachineFactory.__init__
simvoc.core.common_reader.CommonReader.__init__
simvoc.core.condor_sim.Condor.__init__
simvoc.core.control_scheduler.ControlScheduler.__init__
simvoc.core.db_output.DBOutput.__init__
simvoc.core.duplicate_filter.DuplicateFilter.__init__
simvoc.core.filter_results.ResultFilter.__init__
simvoc.core.grid_sim.Grid.__init__
simvoc.core.input_manager.FlexInput.__init__
simvoc.core.job_format_reader.JobReader.__init__
simvoc.core.job_model.Job.__init__
simvoc.core.job_model.PilotJob.__init__
simvoc.core.kernel.Event.__init__
simvoc.core.kernel.EventQueue.__init__
simvoc.core.kernel.Output.__init__
simvoc.core.kernel.Simulator.__init__
simvoc.core.kernel.StreamOutput.__init__
simvoc.core.map_format_reader.MapReader.__init__
simvoc.core.metascheduler.Metascheduler.__init__
simvoc.core.results.AggregationResult.__init__
simvoc.core.results.DiscardResult.__init__
simvoc.core.results.DiscrepancyResult.__init__
simvoc.core.results.FileRequestResult.__init__
simvoc.core.results.FileTransferResult.__init__
simvoc.core.results.JobResult.__init__
simvoc.core.results.JobStartResult.__init__
simvoc.core.results.JobSubmitResult.__init__
simvoc.core.results.MetadataResult.__init__
simvoc.core.results.Result.__init__
simvoc.core.results.SchedResult.__init__
simvoc.core.results.SiteRejectionResult.__init__
simvoc.core.results.SiteResult.__init__
simvoc.core.results.TraceResult.__init__
simvoc.core.results.VMPilotResult.__init__
simvoc.core.results.VMResult.__init__
simvoc.core.results.VOCResult.__init__
simvoc.core.results.VOResult.__init__
simvoc.core.results.WatchdogResult.__init__
simvoc.core.scheduler.Scheduler.__init__
simvoc.core.storage.DataFile.__init__
simvoc.core.storage.FileCache.__init__
simvoc.core.storage.FileStore.__init__
simvoc.core.virtualization.VMHost.__init__
simvoc.core.virtualization.VMImage.__init__
simvoc.core.virtualization.VMMonitor.__init__
simvoc.core.virtualization.VirtualMachine.__init__
simvoc.core.vo_format_reader.VO.__init__
simvoc.core.vo_format_reader.VOReader.__init__
simvoc.core.voc_sim.AutoVOC.__init__
simvoc.core.voc_sim.VMPilot.__init__
simvoc.core.voc_sim.VOC.__init__
simvoc.core.watchdog_sim.WatchRecord.__init__
simvoc.core.watchdog_sim.Watchdog.__init__
simvoc.input.common_writer.CommonWriter.__init__
simvoc.input.data_input.Data.__init__
simvoc.input.egee_map_input.EGEEMap.__init__
simvoc.input.egee_map_input.SiteParser.__init__
simvoc.input.egee_rtm_input.JobTrace.__init__
simvoc.input.flat_data_input.FlatData.__init__
simvoc.input.job_format_writer.JobWriter.__init__
simvoc.input.map_format_writer.MapWriter.__init__
simvoc.input.mod_ldif.LDIFCopy.__init__
simvoc.input.mod_ldif.LDIFParser.__init__
simvoc.input.mod_ldif.LDIFRecordList.__init__
simvoc.input.mod_ldif.LDIFWriter.__init__
simvoc.input.tabbed_data_input.TabbedData.__init__
simvoc.input.vo_format_writer.VOWriter.__init__" class="py-name" href="#" onclick="return doclink('link-5', '__init__', 'link-5');">__init__</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">output</tt><tt class="py-op">)</tt> </tt>
<a name="L236"></a><tt class="py-lineno">236</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fh</tt> <tt class="py-op">=</tt> <tt class="py-name">fh</tt> </tt>
</div><a name="StreamOutput.handle_append"></a><div id="StreamOutput.handle_append-def"><a name="L237"></a><tt class="py-lineno">237</tt> <a class="py-toggle" href="#" id="StreamOutput.handle_append-toggle" onclick="return toggle('StreamOutput.handle_append');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.StreamOutput-class.html#handle_append">handle_append</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">result</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="StreamOutput.handle_append-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="StreamOutput.handle_append-expanded"><a name="L238"></a><tt class="py-lineno">238</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L239"></a><tt class="py-lineno">239</tt>  <tt class="py-line"><tt class="py-docstring">      Private method: writes a string representation of the result (using</tt> </tt>
<a name="L240"></a><tt class="py-lineno">240</tt>  <tt class="py-line"><tt class="py-docstring">      str()) to the output stream.</tt> </tt>
<a name="L241"></a><tt class="py-lineno">241</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L242"></a><tt class="py-lineno">242</tt>  <tt class="py-line"><tt class="py-docstring">      @param result: Result object to be converted to a string and written</tt> </tt>
<a name="L243"></a><tt class="py-lineno">243</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L244"></a><tt class="py-lineno">244</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fh</tt><tt class="py-op">.</tt><tt class="py-name">write</tt><tt class="py-op">(</tt><tt class="py-string">'%s\n'</tt> <tt class="py-op">%</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
</div><a name="StreamOutput.handle_close"></a><div id="StreamOutput.handle_close-def"><a name="L245"></a><tt class="py-lineno">245</tt> <a class="py-toggle" href="#" id="StreamOutput.handle_close-toggle" onclick="return toggle('StreamOutput.handle_close');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.StreamOutput-class.html#handle_close">handle_close</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="StreamOutput.handle_close-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="StreamOutput.handle_close-expanded"><a name="L246"></a><tt class="py-lineno">246</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L247"></a><tt class="py-lineno">247</tt>  <tt class="py-line"><tt class="py-docstring">      Private method: does nothing. Since the stream may be a standard I/O</tt> </tt>
<a name="L248"></a><tt class="py-lineno">248</tt>  <tt class="py-line"><tt class="py-docstring">      stream (such as stdout), this class does NOT close it.</tt> </tt>
<a name="L249"></a><tt class="py-lineno">249</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L250"></a><tt class="py-lineno">250</tt>  <tt class="py-line">      <tt class="py-keyword">pass</tt> </tt>
</div></div><a name="L251"></a><tt class="py-lineno">251</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L252"></a><tt class="py-lineno">252</tt>  <tt class="py-line"> </tt>
<a name="L253"></a><tt class="py-lineno">253</tt>  <tt class="py-line"> </tt>
<a name="Event"></a><div id="Event-def"><a name="L254"></a><tt class="py-lineno">254</tt> <a class="py-toggle" href="#" id="Event-toggle" onclick="return toggle('Event');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.kernel.Event-class.html">Event</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Event-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Event-expanded"><a name="L255"></a><tt class="py-lineno">255</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L256"></a><tt class="py-lineno">256</tt>  <tt class="py-line"><tt class="py-docstring">   Abstract representation of simulator events. Each event invokes a single</tt> </tt>
<a name="L257"></a><tt class="py-lineno">257</tt>  <tt class="py-line"><tt class="py-docstring">   function, to which the specified arguments and keywords are passed. If the</tt> </tt>
<a name="L258"></a><tt class="py-lineno">258</tt>  <tt class="py-line"><tt class="py-docstring">   function is simulator-aware (non-external), then the current simulated time</tt> </tt>
<a name="L259"></a><tt class="py-lineno">259</tt>  <tt class="py-line"><tt class="py-docstring">   and simulator instance are passed as the first two arguments to the</tt> </tt>
<a name="L260"></a><tt class="py-lineno">260</tt>  <tt class="py-line"><tt class="py-docstring">   function.</tt> </tt>
<a name="L261"></a><tt class="py-lineno">261</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L262"></a><tt class="py-lineno">262</tt>  <tt class="py-line"><tt class="py-docstring">   Two classes of events exist: regular and periodic. Regular events are</tt> </tt>
<a name="L263"></a><tt class="py-lineno">263</tt>  <tt class="py-line"><tt class="py-docstring">   intended for simulating actions that do not occur on a fixed (periodic)</tt> </tt>
<a name="L264"></a><tt class="py-lineno">264</tt>  <tt class="py-line"><tt class="py-docstring">   cycle. Periodic events are provided for the purpose of simulating events</tt> </tt>
<a name="L265"></a><tt class="py-lineno">265</tt>  <tt class="py-line"><tt class="py-docstring">   that occur at normal intervals throughout the simulation, which should</tt> </tt>
<a name="L266"></a><tt class="py-lineno">266</tt>  <tt class="py-line"><tt class="py-docstring">   cease to be created once the interesting (regular) events have all been</tt> </tt>
<a name="L267"></a><tt class="py-lineno">267</tt>  <tt class="py-line"><tt class="py-docstring">   handled.</tt> </tt>
<a name="L268"></a><tt class="py-lineno">268</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="Event.__init__"></a><div id="Event.__init__-def"><a name="L269"></a><tt class="py-lineno">269</tt> <a class="py-toggle" href="#" id="Event.__init__-toggle" onclick="return toggle('Event.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Event-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">regular</tt><tt class="py-op">,</tt> <tt class="py-param">extern</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Event.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Event.__init__-expanded"><a name="L270"></a><tt class="py-lineno">270</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L271"></a><tt class="py-lineno">271</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Simulator instance</tt> </tt>
<a name="L272"></a><tt class="py-lineno">272</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L273"></a><tt class="py-lineno">273</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L274"></a><tt class="py-lineno">274</tt>  <tt class="py-line"><tt class="py-docstring">      @param regular: specifies whether event is regular or periodic</tt> </tt>
<a name="L275"></a><tt class="py-lineno">275</tt>  <tt class="py-line"><tt class="py-docstring">      @type regular: bool</tt> </tt>
<a name="L276"></a><tt class="py-lineno">276</tt>  <tt class="py-line"><tt class="py-docstring">      @param extern: specifies whether event is external to the simulator</tt> </tt>
<a name="L277"></a><tt class="py-lineno">277</tt>  <tt class="py-line"><tt class="py-docstring">                     or is simulator-aware</tt> </tt>
<a name="L278"></a><tt class="py-lineno">278</tt>  <tt class="py-line"><tt class="py-docstring">      @type extern: bool</tt> </tt>
<a name="L279"></a><tt class="py-lineno">279</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L280"></a><tt class="py-lineno">280</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L281"></a><tt class="py-lineno">281</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywords to be passed to the function</tt> </tt>
<a name="L282"></a><tt class="py-lineno">282</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L283"></a><tt class="py-lineno">283</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">act_time</tt><tt class="py-op">)</tt> <tt class="py-keyword">not</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">int</tt><tt class="py-op">,</tt> <tt class="py-name">float</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L284"></a><tt class="py-lineno">284</tt>  <tt class="py-line">         <tt class="py-keyword">raise</tt> <tt class="py-name">TypeError</tt><tt class="py-op">(</tt><tt class="py-string">'Event activation time must be numeric'</tt><tt class="py-op">)</tt> </tt>
<a name="L285"></a><tt class="py-lineno">285</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt> <tt class="py-op">=</tt> <tt class="py-name">sim</tt> </tt>
<a name="L286"></a><tt class="py-lineno">286</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> <tt class="py-op">=</tt> <tt class="py-name">act_time</tt> </tt>
<a name="L287"></a><tt class="py-lineno">287</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">keepalive</tt> <tt class="py-op">=</tt> <tt class="py-name">regular</tt> </tt>
<a name="L288"></a><tt class="py-lineno">288</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt> <tt class="py-op">=</tt> <tt class="py-name">fn</tt> </tt>
<a name="L289"></a><tt class="py-lineno">289</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">args</tt> <tt class="py-op">=</tt> <tt class="py-name">list</tt><tt class="py-op">(</tt><tt class="py-name">args</tt><tt class="py-op">)</tt> </tt>
<a name="L290"></a><tt class="py-lineno">290</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">kwds</tt> <tt class="py-op">=</tt> <tt class="py-name">kwds</tt> </tt>
<a name="L291"></a><tt class="py-lineno">291</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">activated</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L292"></a><tt class="py-lineno">292</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cancel</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L293"></a><tt class="py-lineno">293</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">extern</tt><tt class="py-op">:</tt> </tt>
<a name="L294"></a><tt class="py-lineno">294</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">insert</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">sim</tt><tt class="py-op">)</tt> </tt>
<a name="L295"></a><tt class="py-lineno">295</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">.</tt><tt class="py-name">insert</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">)</tt> </tt>
</div><a name="Event.activate"></a><div id="Event.activate-def"><a name="L296"></a><tt class="py-lineno">296</tt> <a class="py-toggle" href="#" id="Event.activate-toggle" onclick="return toggle('Event.activate');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Event-class.html#activate">activate</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">simobj</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Event.activate-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Event.activate-expanded"><a name="L297"></a><tt class="py-lineno">297</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L298"></a><tt class="py-lineno">298</tt>  <tt class="py-line"><tt class="py-docstring">      Method called by the simulator when the event is to be activated. Runs</tt> </tt>
<a name="L299"></a><tt class="py-lineno">299</tt>  <tt class="py-line"><tt class="py-docstring">      the function specified in the constructor, with the specified arguments</tt> </tt>
<a name="L300"></a><tt class="py-lineno">300</tt>  <tt class="py-line"><tt class="py-docstring">      and keywords. If the event has been canceled, this method does nothing.</tt> </tt>
<a name="L301"></a><tt class="py-lineno">301</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L302"></a><tt class="py-lineno">302</tt>  <tt class="py-line"><tt class="py-docstring">      @param simobj: Reference to the simulator object</tt> </tt>
<a name="L303"></a><tt class="py-lineno">303</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L304"></a><tt class="py-lineno">304</tt>  <tt class="py-line"><tt class="py-docstring">      @return: return value of the function that is invoked, if any</tt> </tt>
<a name="L305"></a><tt class="py-lineno">305</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L306"></a><tt class="py-lineno">306</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">cancel</tt><tt class="py-op">:</tt> </tt>
<a name="L307"></a><tt class="py-lineno">307</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">activated</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L308"></a><tt class="py-lineno">308</tt>  <tt class="py-line">         <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">fn</tt><tt class="py-op">(</tt><tt class="py-op">*</tt><tt class="py-name">tuple</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">args</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L309"></a><tt class="py-lineno">309</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L310"></a><tt class="py-lineno">310</tt>  <tt class="py-line"> </tt>
<a name="L311"></a><tt class="py-lineno">311</tt>  <tt class="py-line"> </tt>
<a name="EventQueue"></a><div id="EventQueue-def"><a name="L312"></a><tt class="py-lineno">312</tt> <a class="py-toggle" href="#" id="EventQueue-toggle" onclick="return toggle('EventQueue');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html">EventQueue</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="EventQueue-expanded"><a name="L313"></a><tt class="py-lineno">313</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L314"></a><tt class="py-lineno">314</tt>  <tt class="py-line"><tt class="py-docstring">   Simulator event queue, implemented using the Python heapq module. Events</tt> </tt>
<a name="L315"></a><tt class="py-lineno">315</tt>  <tt class="py-line"><tt class="py-docstring">   are partially ordered with respect to activation time, with the caveat that</tt> </tt>
<a name="L316"></a><tt class="py-lineno">316</tt>  <tt class="py-line"><tt class="py-docstring">   multiple events scheduled to activate at the same time may activate in any</tt> </tt>
<a name="L317"></a><tt class="py-lineno">317</tt>  <tt class="py-line"><tt class="py-docstring">   order.</tt> </tt>
<a name="L318"></a><tt class="py-lineno">318</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="EventQueue.__init__"></a><div id="EventQueue.__init__-def"><a name="L319"></a><tt class="py-lineno">319</tt> <a class="py-toggle" href="#" id="EventQueue.__init__-toggle" onclick="return toggle('EventQueue.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.__init__-expanded"><a name="L320"></a><tt class="py-lineno">320</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">queue</tt> <tt class="py-op">=</tt> <tt class="py-op">[</tt><tt class="py-op">]</tt> </tt>
<a name="L321"></a><tt class="py-lineno">321</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">event_map</tt> <tt class="py-op">=</tt> <tt class="py-op">{</tt><tt class="py-op">}</tt> </tt>
<a name="L322"></a><tt class="py-lineno">322</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">regular</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
</div><a name="EventQueue.get_size"></a><div id="EventQueue.get_size-def"><a name="L323"></a><tt class="py-lineno">323</tt> <a class="py-toggle" href="#" id="EventQueue.get_size-toggle" onclick="return toggle('EventQueue.get_size');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#get_size">get_size</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.get_size-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.get_size-expanded"><a name="L324"></a><tt class="py-lineno">324</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L325"></a><tt class="py-lineno">325</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: int</tt> </tt>
<a name="L326"></a><tt class="py-lineno">326</tt>  <tt class="py-line"><tt class="py-docstring">      @return: current size of the event queue</tt> </tt>
<a name="L327"></a><tt class="py-lineno">327</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L328"></a><tt class="py-lineno">328</tt>  <tt class="py-line">      <tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">queue</tt><tt class="py-op">)</tt> </tt>
<a name="L329"></a><tt class="py-lineno">329</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">size</tt> </tt>
</div><a name="EventQueue.has_events"></a><div id="EventQueue.has_events-def"><a name="L330"></a><tt class="py-lineno">330</tt> <a class="py-toggle" href="#" id="EventQueue.has_events-toggle" onclick="return toggle('EventQueue.has_events');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#has_events">has_events</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.has_events-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.has_events-expanded"><a name="L331"></a><tt class="py-lineno">331</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L332"></a><tt class="py-lineno">332</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: bool</tt> </tt>
<a name="L333"></a><tt class="py-lineno">333</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True iff the event queue is non-empty</tt> </tt>
<a name="L334"></a><tt class="py-lineno">334</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L335"></a><tt class="py-lineno">335</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">queue</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
</div><a name="EventQueue.has_regular_events"></a><div id="EventQueue.has_regular_events-def"><a name="L336"></a><tt class="py-lineno">336</tt> <a class="py-toggle" href="#" id="EventQueue.has_regular_events-toggle" onclick="return toggle('EventQueue.has_regular_events');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#has_regular_events">has_regular_events</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.has_regular_events-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.has_regular_events-expanded"><a name="L337"></a><tt class="py-lineno">337</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L338"></a><tt class="py-lineno">338</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: bool</tt> </tt>
<a name="L339"></a><tt class="py-lineno">339</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True iff there are regular (non-periodic) events in the queue</tt> </tt>
<a name="L340"></a><tt class="py-lineno">340</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L341"></a><tt class="py-lineno">341</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">regular</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
</div><a name="EventQueue.cancel_event"></a><div id="EventQueue.cancel_event-def"><a name="L342"></a><tt class="py-lineno">342</tt> <a class="py-toggle" href="#" id="EventQueue.cancel_event-toggle" onclick="return toggle('EventQueue.cancel_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#cancel_event">cancel_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">evt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.cancel_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.cancel_event-expanded"><a name="L343"></a><tt class="py-lineno">343</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L344"></a><tt class="py-lineno">344</tt>  <tt class="py-line"><tt class="py-docstring">      Cancels a scheduled event that is waiting in the queue. If the event is</tt> </tt>
<a name="L345"></a><tt class="py-lineno">345</tt>  <tt class="py-line"><tt class="py-docstring">      not found in the queue, an Exception will be raised. Upon cancellation,</tt> </tt>
<a name="L346"></a><tt class="py-lineno">346</tt>  <tt class="py-line"><tt class="py-docstring">      the event will be marked as activated, so that periodic scheduling code</tt> </tt>
<a name="L347"></a><tt class="py-lineno">347</tt>  <tt class="py-line"><tt class="py-docstring">      behaves properly.</tt> </tt>
<a name="L348"></a><tt class="py-lineno">348</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L349"></a><tt class="py-lineno">349</tt>  <tt class="py-line"><tt class="py-docstring">      @param evt: Event to cancel</tt> </tt>
<a name="L350"></a><tt class="py-lineno">350</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L351"></a><tt class="py-lineno">351</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">keepalive</tt><tt class="py-op">:</tt> </tt>
<a name="L352"></a><tt class="py-lineno">352</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">regular</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
<a name="L353"></a><tt class="py-lineno">353</tt>  <tt class="py-line">      <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">activated</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L354"></a><tt class="py-lineno">354</tt>  <tt class="py-line">      <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">cancel</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
</div><a name="EventQueue.add_event"></a><div id="EventQueue.add_event-def"><a name="L355"></a><tt class="py-lineno">355</tt> <a class="py-toggle" href="#" id="EventQueue.add_event-toggle" onclick="return toggle('EventQueue.add_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#add_event">add_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">evt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.add_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.add_event-expanded"><a name="L356"></a><tt class="py-lineno">356</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L357"></a><tt class="py-lineno">357</tt>  <tt class="py-line"><tt class="py-docstring">      Adds an event to the queue. Events must not specify an activation time</tt> </tt>
<a name="L358"></a><tt class="py-lineno">358</tt>  <tt class="py-line"><tt class="py-docstring">      earlier than the current simulated time, or a TimeTravelException will</tt> </tt>
<a name="L359"></a><tt class="py-lineno">359</tt>  <tt class="py-line"><tt class="py-docstring">      be raised.</tt> </tt>
<a name="L360"></a><tt class="py-lineno">360</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L361"></a><tt class="py-lineno">361</tt>  <tt class="py-line"><tt class="py-docstring">      @param evt: Event to be added to the queue</tt> </tt>
<a name="L362"></a><tt class="py-lineno">362</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L363"></a><tt class="py-lineno">363</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L364"></a><tt class="py-lineno">364</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L365"></a><tt class="py-lineno">365</tt>  <tt class="py-line">      <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> </tt>
<a name="L366"></a><tt class="py-lineno">366</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">keepalive</tt><tt class="py-op">:</tt> </tt>
<a name="L367"></a><tt class="py-lineno">367</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">regular</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L368"></a><tt class="py-lineno">368</tt>  <tt class="py-line">      <tt class="py-name">heapq</tt><tt class="py-op">.</tt><tt class="py-name">heappush</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">queue</tt><tt class="py-op">,</tt> <tt class="py-op">(</tt><tt class="py-name">t</tt><tt class="py-op">,</tt> <tt class="py-name">evt</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L369"></a><tt class="py-lineno">369</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">evt</tt> </tt>
</div><a name="L370"></a><tt class="py-lineno">370</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="EventQueue.adjust_events"></a><div id="EventQueue.adjust_events-def"><a name="L371"></a><tt class="py-lineno">371</tt> <a class="py-toggle" href="#" id="EventQueue.adjust_events-toggle" onclick="return toggle('EventQueue.adjust_events');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#adjust_events">adjust_events</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">clock</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.adjust_events-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.adjust_events-expanded"><a name="L372"></a><tt class="py-lineno">372</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L373"></a><tt class="py-lineno">373</tt>  <tt class="py-line"><tt class="py-docstring">      Adjusts event times if the simulator start clock changes. This method</tt> </tt>
<a name="L374"></a><tt class="py-lineno">374</tt>  <tt class="py-line"><tt class="py-docstring">      is intended to be called only by the simulator and only before starting</tt> </tt>
<a name="L375"></a><tt class="py-lineno">375</tt>  <tt class="py-line"><tt class="py-docstring">      the actual simulation.</tt> </tt>
<a name="L376"></a><tt class="py-lineno">376</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L377"></a><tt class="py-lineno">377</tt>  <tt class="py-line"><tt class="py-docstring">      @param clock: New start clock value</tt> </tt>
<a name="L378"></a><tt class="py-lineno">378</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L379"></a><tt class="py-lineno">379</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L380"></a><tt class="py-lineno">380</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L381"></a><tt class="py-lineno">381</tt>  <tt class="py-line">      <tt class="py-keyword">for</tt> <tt class="py-name">evt</tt> <tt class="py-keyword">in</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">queue</tt><tt class="py-op">:</tt> </tt>
<a name="L382"></a><tt class="py-lineno">382</tt>  <tt class="py-line">         <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> <tt class="py-op">+=</tt> <tt class="py-name">clock</tt> </tt>
</div><a name="L383"></a><tt class="py-lineno">383</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="EventQueue.new_event"></a><div id="EventQueue.new_event-def"><a name="L384"></a><tt class="py-lineno">384</tt> <a class="py-toggle" href="#" id="EventQueue.new_event-toggle" onclick="return toggle('EventQueue.new_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#new_event">new_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">regular</tt><tt class="py-op">,</tt> <tt class="py-param">extern</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.new_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.new_event-expanded"><a name="L385"></a><tt class="py-lineno">385</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L386"></a><tt class="py-lineno">386</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new event</tt> </tt>
<a name="L387"></a><tt class="py-lineno">387</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L388"></a><tt class="py-lineno">388</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Reference to the Simulator object</tt> </tt>
<a name="L389"></a><tt class="py-lineno">389</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L390"></a><tt class="py-lineno">390</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L391"></a><tt class="py-lineno">391</tt>  <tt class="py-line"><tt class="py-docstring">      @param regular: specifies whether event is regular or periodic</tt> </tt>
<a name="L392"></a><tt class="py-lineno">392</tt>  <tt class="py-line"><tt class="py-docstring">      @type regular: bool</tt> </tt>
<a name="L393"></a><tt class="py-lineno">393</tt>  <tt class="py-line"><tt class="py-docstring">      @param extern: specifies whether event is external to the simulator or</tt> </tt>
<a name="L394"></a><tt class="py-lineno">394</tt>  <tt class="py-line"><tt class="py-docstring">                     is simulator-aware</tt> </tt>
<a name="L395"></a><tt class="py-lineno">395</tt>  <tt class="py-line"><tt class="py-docstring">      @type extern: bool</tt> </tt>
<a name="L396"></a><tt class="py-lineno">396</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L397"></a><tt class="py-lineno">397</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L398"></a><tt class="py-lineno">398</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L399"></a><tt class="py-lineno">399</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L400"></a><tt class="py-lineno">400</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L401"></a><tt class="py-lineno">401</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L402"></a><tt class="py-lineno">402</tt>  <tt class="py-line">      <tt class="py-name">evt</tt> <tt class="py-op">=</tt> <tt id="link-6" class="py-name" targets="Class simvoc.core.kernel.Event=simvoc.core.kernel.Event-class.html"><a title="simvoc.core.kernel.Event" class="py-name" href="#" onclick="return doclink('link-6', 'Event', 'link-6');">Event</a></tt><tt class="py-op">(</tt><tt class="py-name">sim</tt><tt class="py-op">,</tt> <tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">regular</tt><tt class="py-op">,</tt> <tt class="py-name">extern</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
<a name="L403"></a><tt class="py-lineno">403</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-7" class="py-name" targets="Method simvoc.core.kernel.EventQueue.add_event()=simvoc.core.kernel.EventQueue-class.html#add_event,Method simvoc.core.kernel.Simulator.add_event()=simvoc.core.kernel.Simulator-class.html#add_event"><a title="simvoc.core.kernel.EventQueue.add_event
simvoc.core.kernel.Simulator.add_event" class="py-name" href="#" onclick="return doclink('link-7', 'add_event', 'link-7');">add_event</a></tt><tt class="py-op">(</tt><tt class="py-name">evt</tt><tt class="py-op">)</tt> </tt>
</div><a name="L404"></a><tt class="py-lineno">404</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="EventQueue.new_simple_event"></a><div id="EventQueue.new_simple_event-def"><a name="L405"></a><tt class="py-lineno">405</tt> <a class="py-toggle" href="#" id="EventQueue.new_simple_event-toggle" onclick="return toggle('EventQueue.new_simple_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#new_simple_event">new_simple_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.new_simple_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.new_simple_event-expanded"><a name="L406"></a><tt class="py-lineno">406</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L407"></a><tt class="py-lineno">407</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new REGULAR event that invokes a</tt> </tt>
<a name="L408"></a><tt class="py-lineno">408</tt>  <tt class="py-line"><tt class="py-docstring">      simulator-aware (non-external) function. The first two arguments to</tt> </tt>
<a name="L409"></a><tt class="py-lineno">409</tt>  <tt class="py-line"><tt class="py-docstring">      the function will be the current simulated time and a reference to</tt> </tt>
<a name="L410"></a><tt class="py-lineno">410</tt>  <tt class="py-line"><tt class="py-docstring">      the Simulator itself.</tt> </tt>
<a name="L411"></a><tt class="py-lineno">411</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L412"></a><tt class="py-lineno">412</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Reference to the Simulator object</tt> </tt>
<a name="L413"></a><tt class="py-lineno">413</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L414"></a><tt class="py-lineno">414</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L415"></a><tt class="py-lineno">415</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L416"></a><tt class="py-lineno">416</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L417"></a><tt class="py-lineno">417</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L418"></a><tt class="py-lineno">418</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L419"></a><tt class="py-lineno">419</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L420"></a><tt class="py-lineno">420</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L421"></a><tt class="py-lineno">421</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-8" class="py-name" targets="Method simvoc.core.kernel.EventQueue.new_event()=simvoc.core.kernel.EventQueue-class.html#new_event,Method simvoc.core.kernel.Simulator.new_event()=simvoc.core.kernel.Simulator-class.html#new_event"><a title="simvoc.core.kernel.EventQueue.new_event
simvoc.core.kernel.Simulator.new_event" class="py-name" href="#" onclick="return doclink('link-8', 'new_event', 'link-8');">new_event</a></tt><tt class="py-op">(</tt><tt class="py-name">sim</tt><tt class="py-op">,</tt> <tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
</div><a name="L422"></a><tt class="py-lineno">422</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="EventQueue.new_periodic_event"></a><div id="EventQueue.new_periodic_event-def"><a name="L423"></a><tt class="py-lineno">423</tt> <a class="py-toggle" href="#" id="EventQueue.new_periodic_event-toggle" onclick="return toggle('EventQueue.new_periodic_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#new_periodic_event">new_periodic_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.new_periodic_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.new_periodic_event-expanded"><a name="L424"></a><tt class="py-lineno">424</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L425"></a><tt class="py-lineno">425</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new PERIODIC event that invokes a</tt> </tt>
<a name="L426"></a><tt class="py-lineno">426</tt>  <tt class="py-line"><tt class="py-docstring">      simulator-aware (non-external) function. The first two arguments to</tt> </tt>
<a name="L427"></a><tt class="py-lineno">427</tt>  <tt class="py-line"><tt class="py-docstring">      the function will be the current simulated time and a reference to</tt> </tt>
<a name="L428"></a><tt class="py-lineno">428</tt>  <tt class="py-line"><tt class="py-docstring">      the Simulator itself.</tt> </tt>
<a name="L429"></a><tt class="py-lineno">429</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L430"></a><tt class="py-lineno">430</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Reference to the Simulator object</tt> </tt>
<a name="L431"></a><tt class="py-lineno">431</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L432"></a><tt class="py-lineno">432</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L433"></a><tt class="py-lineno">433</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L434"></a><tt class="py-lineno">434</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L435"></a><tt class="py-lineno">435</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L436"></a><tt class="py-lineno">436</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L437"></a><tt class="py-lineno">437</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L438"></a><tt class="py-lineno">438</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L439"></a><tt class="py-lineno">439</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-9" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_event
simvoc.core.kernel.Simulator.new_event" class="py-name" href="#" onclick="return doclink('link-9', 'new_event', 'link-8');">new_event</a></tt><tt class="py-op">(</tt><tt class="py-name">sim</tt><tt class="py-op">,</tt> <tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
</div><a name="L440"></a><tt class="py-lineno">440</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="EventQueue.new_external_event"></a><div id="EventQueue.new_external_event-def"><a name="L441"></a><tt class="py-lineno">441</tt> <a class="py-toggle" href="#" id="EventQueue.new_external_event-toggle" onclick="return toggle('EventQueue.new_external_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#new_external_event">new_external_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">sim</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.new_external_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.new_external_event-expanded"><a name="L442"></a><tt class="py-lineno">442</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L443"></a><tt class="py-lineno">443</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new REGULAR event that invokes an EXTERNAL</tt> </tt>
<a name="L444"></a><tt class="py-lineno">444</tt>  <tt class="py-line"><tt class="py-docstring">      (non simulator-aware) function. The current time and simulator</tt> </tt>
<a name="L445"></a><tt class="py-lineno">445</tt>  <tt class="py-line"><tt class="py-docstring">      reference will NOT be passed to the function.</tt> </tt>
<a name="L446"></a><tt class="py-lineno">446</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L447"></a><tt class="py-lineno">447</tt>  <tt class="py-line"><tt class="py-docstring">      @param sim: Reference to the Simulator object</tt> </tt>
<a name="L448"></a><tt class="py-lineno">448</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L449"></a><tt class="py-lineno">449</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L450"></a><tt class="py-lineno">450</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L451"></a><tt class="py-lineno">451</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L452"></a><tt class="py-lineno">452</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L453"></a><tt class="py-lineno">453</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L454"></a><tt class="py-lineno">454</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L455"></a><tt class="py-lineno">455</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L456"></a><tt class="py-lineno">456</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-10" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_event
simvoc.core.kernel.Simulator.new_event" class="py-name" href="#" onclick="return doclink('link-10', 'new_event', 'link-8');">new_event</a></tt><tt class="py-op">(</tt><tt class="py-name">sim</tt><tt class="py-op">,</tt> <tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
</div><a name="L457"></a><tt class="py-lineno">457</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="L458"></a><tt class="py-lineno">458</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="EventQueue.pop"></a><div id="EventQueue.pop-def"><a name="L459"></a><tt class="py-lineno">459</tt> <a class="py-toggle" href="#" id="EventQueue.pop-toggle" onclick="return toggle('EventQueue.pop');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#pop">pop</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.pop-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.pop-expanded"><a name="L460"></a><tt class="py-lineno">460</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L461"></a><tt class="py-lineno">461</tt>  <tt class="py-line"><tt class="py-docstring">      Removes and returns the next event in the simulation, partially</tt> </tt>
<a name="L462"></a><tt class="py-lineno">462</tt>  <tt class="py-line"><tt class="py-docstring">      ordered by activation time</tt> </tt>
<a name="L463"></a><tt class="py-lineno">463</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L464"></a><tt class="py-lineno">464</tt>  <tt class="py-line">      <tt class="py-name">t</tt><tt class="py-op">,</tt> <tt class="py-name">e</tt> <tt class="py-op">=</tt> <tt class="py-name">heapq</tt><tt class="py-op">.</tt><tt class="py-name">heappop</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">queue</tt><tt class="py-op">)</tt> </tt>
<a name="L465"></a><tt class="py-lineno">465</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">e</tt><tt class="py-op">.</tt><tt class="py-name">keepalive</tt><tt class="py-op">:</tt> </tt>
<a name="L466"></a><tt class="py-lineno">466</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">regular</tt> <tt class="py-op">-=</tt> <tt class="py-number">1</tt> </tt>
<a name="L467"></a><tt class="py-lineno">467</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">e</tt> </tt>
</div><a name="L468"></a><tt class="py-lineno">468</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="L469"></a><tt class="py-lineno">469</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="EventQueue.__str__"></a><div id="EventQueue.__str__-def"><a name="L470"></a><tt class="py-lineno">470</tt> <a class="py-toggle" href="#" id="EventQueue.__str__-toggle" onclick="return toggle('EventQueue.__str__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.EventQueue-class.html#__str__">__str__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="EventQueue.__str__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="EventQueue.__str__-expanded"><a name="L471"></a><tt class="py-lineno">471</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">queue</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L472"></a><tt class="py-lineno">472</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L473"></a><tt class="py-lineno">473</tt>  <tt class="py-line"> </tt>
<a name="L474"></a><tt class="py-lineno">474</tt>  <tt class="py-line"> </tt>
<a name="Simulator"></a><div id="Simulator-def"><a name="L475"></a><tt class="py-lineno">475</tt> <a class="py-toggle" href="#" id="Simulator-toggle" onclick="return toggle('Simulator');">-</a><tt class="py-line"><tt class="py-keyword">class</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html">Simulator</a><tt class="py-op">(</tt><tt class="py-base-class">object</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator-collapsed" style="display:none;" pad="+++" indent="++++"></div><div id="Simulator-expanded"><a name="L476"></a><tt class="py-lineno">476</tt>  <tt class="py-line">   <tt class="py-docstring">'''</tt> </tt>
<a name="L477"></a><tt class="py-lineno">477</tt>  <tt class="py-line"><tt class="py-docstring">   Core Simulator class, which provides an event-driven discrete event</tt> </tt>
<a name="L478"></a><tt class="py-lineno">478</tt>  <tt class="py-line"><tt class="py-docstring">   simulation. Simulations using this simulator core will continue to run</tt> </tt>
<a name="L479"></a><tt class="py-lineno">479</tt>  <tt class="py-line"><tt class="py-docstring">   until the event queue is empty. It is up to the client code to detect</tt> </tt>
<a name="L480"></a><tt class="py-lineno">480</tt>  <tt class="py-line"><tt class="py-docstring">   when to stop scheduling periodic events, unless an infinite simulation is</tt> </tt>
<a name="L481"></a><tt class="py-lineno">481</tt>  <tt class="py-line"><tt class="py-docstring">   desired.</tt> </tt>
<a name="L482"></a><tt class="py-lineno">482</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L483"></a><tt class="py-lineno">483</tt>  <tt class="py-line"><tt class="py-docstring">   The Simulator provides a source of randomness (using the Python random</tt> </tt>
<a name="L484"></a><tt class="py-lineno">484</tt>  <tt class="py-line"><tt class="py-docstring">   module) to client code. Centralizing the random source has the advantage</tt> </tt>
<a name="L485"></a><tt class="py-lineno">485</tt>  <tt class="py-line"><tt class="py-docstring">   of allowing the pseudo-random generator to be seeded globally, providing</tt> </tt>
<a name="L486"></a><tt class="py-lineno">486</tt>  <tt class="py-line"><tt class="py-docstring">   for repeatable results.</tt> </tt>
<a name="L487"></a><tt class="py-lineno">487</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L488"></a><tt class="py-lineno">488</tt>  <tt class="py-line"><tt class="py-docstring">   During simulator execution, updates on the queue size and event rate are</tt> </tt>
<a name="L489"></a><tt class="py-lineno">489</tt>  <tt class="py-line"><tt class="py-docstring">   periodically printed to stderr (default every second). Results of the</tt> </tt>
<a name="L490"></a><tt class="py-lineno">490</tt>  <tt class="py-line"><tt class="py-docstring">   simulation are sent to an output handler, while the simulator provides</tt> </tt>
<a name="L491"></a><tt class="py-lineno">491</tt>  <tt class="py-line"><tt class="py-docstring">   trace data and final metadata to external functions.</tt> </tt>
<a name="L492"></a><tt class="py-lineno">492</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L493"></a><tt class="py-lineno">493</tt>  <tt class="py-line"><tt class="py-docstring">   A debugging mechanism is included in the simulator. This mechanism allows</tt> </tt>
<a name="L494"></a><tt class="py-lineno">494</tt>  <tt class="py-line"><tt class="py-docstring">   client code to send debugging messages, which can be printed or sent to</tt> </tt>
<a name="L495"></a><tt class="py-lineno">495</tt>  <tt class="py-line"><tt class="py-docstring">   any open file-like object. To assist in debugging infinite simulations,</tt> </tt>
<a name="L496"></a><tt class="py-lineno">496</tt>  <tt class="py-line"><tt class="py-docstring">   an adjustable automatic debugging trigger activates debugging messages</tt> </tt>
<a name="L497"></a><tt class="py-lineno">497</tt>  <tt class="py-line"><tt class="py-docstring">   whenever the event queue contains only periodic events for a large number</tt> </tt>
<a name="L498"></a><tt class="py-lineno">498</tt>  <tt class="py-line"><tt class="py-docstring">   of consecutive iterations of the event loop.</tt> </tt>
<a name="L499"></a><tt class="py-lineno">499</tt>  <tt class="py-line"><tt class="py-docstring">   '''</tt> </tt>
<a name="Simulator.__init__"></a><div id="Simulator.__init__-def"><a name="L500"></a><tt class="py-lineno">500</tt> <a class="py-toggle" href="#" id="Simulator.__init__-toggle" onclick="return toggle('Simulator.__init__');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#__init__">__init__</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">start_clock</tt><tt class="py-op">=</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-param">output_handler</tt><tt class="py-op">=</tt><tt id="link-11" class="py-name" targets="Class simvoc.core.kernel.StreamOutput=simvoc.core.kernel.StreamOutput-class.html"><a title="simvoc.core.kernel.StreamOutput" class="py-name" href="#" onclick="return doclink('link-11', 'StreamOutput', 'link-11');">StreamOutput</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> \ </tt>
<a name="L501"></a><tt class="py-lineno">501</tt>  <tt class="py-line">                <tt class="py-param">event_queue</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">report_interval</tt><tt class="py-op">=</tt><tt class="py-number">1</tt><tt class="py-op">,</tt> <tt class="py-param">ktrace</tt><tt class="py-op">=</tt><tt id="link-12" class="py-name" targets="Function simvoc.core.kernel.kernel_trace()=simvoc.core.kernel-module.html#kernel_trace,Function simvoc.core.results.kernel_trace()=simvoc.core.results-module.html#kernel_trace"><a title="simvoc.core.kernel.kernel_trace
simvoc.core.results.kernel_trace" class="py-name" href="#" onclick="return doclink('link-12', 'kernel_trace', 'link-12');">kernel_trace</a></tt><tt class="py-op">,</tt> \ </tt>
<a name="L502"></a><tt class="py-lineno">502</tt>  <tt class="py-line">                <tt class="py-param">kmeta</tt><tt class="py-op">=</tt><tt id="link-13" class="py-name" targets="Function simvoc.core.kernel.kernel_metadata()=simvoc.core.kernel-module.html#kernel_metadata,Function simvoc.core.results.kernel_metadata()=simvoc.core.results-module.html#kernel_metadata"><a title="simvoc.core.kernel.kernel_metadata
simvoc.core.results.kernel_metadata" class="py-name" href="#" onclick="return doclink('link-13', 'kernel_metadata', 'link-13');">kernel_metadata</a></tt><tt class="py-op">,</tt> <tt class="py-param">rand_seed</tt><tt class="py-op">=</tt><tt class="py-name">None</tt><tt class="py-op">,</tt> <tt class="py-param">debug_fh</tt><tt class="py-op">=</tt><tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stdout</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.__init__-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.__init__-expanded"><a name="L503"></a><tt class="py-lineno">503</tt>  <tt class="py-line"> </tt>
<a name="L504"></a><tt class="py-lineno">504</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L505"></a><tt class="py-lineno">505</tt>  <tt class="py-line"><tt class="py-docstring">      @param start_clock: Initial simulator clock value</tt> </tt>
<a name="L506"></a><tt class="py-lineno">506</tt>  <tt class="py-line"><tt class="py-docstring">      @type start_clock: number</tt> </tt>
<a name="L507"></a><tt class="py-lineno">507</tt>  <tt class="py-line"><tt class="py-docstring">      @param output_handler: Output instance to which results will be sent. If</tt> </tt>
<a name="L508"></a><tt class="py-lineno">508</tt>  <tt class="py-line"><tt class="py-docstring">                             desired, output handlers may be chained together</tt> </tt>
<a name="L509"></a><tt class="py-lineno">509</tt>  <tt class="py-line"><tt class="py-docstring">                             to form a pipeline, in which case the first output</tt> </tt>
<a name="L510"></a><tt class="py-lineno">510</tt>  <tt class="py-line"><tt class="py-docstring">                             handler in the pipeline should be used here.</tt> </tt>
<a name="L511"></a><tt class="py-lineno">511</tt>  <tt class="py-line"><tt class="py-docstring">      @param event_queue: Event queue to use with the simulator. This queue</tt> </tt>
<a name="L512"></a><tt class="py-lineno">512</tt>  <tt class="py-line"><tt class="py-docstring">                          may be populated in advance. If unspecified, a new,</tt> </tt>
<a name="L513"></a><tt class="py-lineno">513</tt>  <tt class="py-line"><tt class="py-docstring">                          empty event queue will be created.</tt> </tt>
<a name="L514"></a><tt class="py-lineno">514</tt>  <tt class="py-line"><tt class="py-docstring">      @param report_interval: Interval (seconds) between trace reports, which</tt> </tt>
<a name="L515"></a><tt class="py-lineno">515</tt>  <tt class="py-line"><tt class="py-docstring">                              are both printed to stderr and send to the ktrace</tt> </tt>
<a name="L516"></a><tt class="py-lineno">516</tt>  <tt class="py-line"><tt class="py-docstring">                              function</tt> </tt>
<a name="L517"></a><tt class="py-lineno">517</tt>  <tt class="py-line"><tt class="py-docstring">      @type report_interval: int</tt> </tt>
<a name="L518"></a><tt class="py-lineno">518</tt>  <tt class="py-line"><tt class="py-docstring">      @param ktrace: Function to which trace reports are sent</tt> </tt>
<a name="L519"></a><tt class="py-lineno">519</tt>  <tt class="py-line"><tt class="py-docstring">      @param kmeta: Function to which execution metadata is sent at the</tt> </tt>
<a name="L520"></a><tt class="py-lineno">520</tt>  <tt class="py-line"><tt class="py-docstring">                    conclusion of a simulation</tt> </tt>
<a name="L521"></a><tt class="py-lineno">521</tt>  <tt class="py-line"><tt class="py-docstring">      @param rand_seed: Random seed (any hashable object). If unspecified</tt> </tt>
<a name="L522"></a><tt class="py-lineno">522</tt>  <tt class="py-line"><tt class="py-docstring">                        or None, the RNG will be seeded using the system</tt> </tt>
<a name="L523"></a><tt class="py-lineno">523</tt>  <tt class="py-line"><tt class="py-docstring">                        clock or operating system random source. See the</tt> </tt>
<a name="L524"></a><tt class="py-lineno">524</tt>  <tt class="py-line"><tt class="py-docstring">                        documentation for the Python L{random} module for</tt> </tt>
<a name="L525"></a><tt class="py-lineno">525</tt>  <tt class="py-line"><tt class="py-docstring">                        more details.</tt> </tt>
<a name="L526"></a><tt class="py-lineno">526</tt>  <tt class="py-line"><tt class="py-docstring">      @param debug_fh: Open file handle (w mode) for debugging messages</tt> </tt>
<a name="L527"></a><tt class="py-lineno">527</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L528"></a><tt class="py-lineno">528</tt>  <tt class="py-line"> </tt>
<a name="L529"></a><tt class="py-lineno">529</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> <tt class="py-op">=</tt> <tt class="py-name">start_clock</tt> </tt>
<a name="L530"></a><tt class="py-lineno">530</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__start_clock</tt> <tt class="py-op">=</tt> <tt class="py-name">start_clock</tt> </tt>
<a name="L531"></a><tt class="py-lineno">531</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L532"></a><tt class="py-lineno">532</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__started</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L533"></a><tt class="py-lineno">533</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_running</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L534"></a><tt class="py-lineno">534</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__results</tt> <tt class="py-op">=</tt> <tt class="py-name">output_handler</tt> </tt>
<a name="L535"></a><tt class="py-lineno">535</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__exec_time</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L536"></a><tt class="py-lineno">536</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-keyword">not</tt> <tt class="py-name">event_queue</tt><tt class="py-op">:</tt> </tt>
<a name="L537"></a><tt class="py-lineno">537</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt> <tt class="py-op">=</tt> <tt id="link-14" class="py-name" targets="Class simvoc.core.kernel.EventQueue=simvoc.core.kernel.EventQueue-class.html"><a title="simvoc.core.kernel.EventQueue" class="py-name" href="#" onclick="return doclink('link-14', 'EventQueue', 'link-14');">EventQueue</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L538"></a><tt class="py-lineno">538</tt>  <tt class="py-line">      <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L539"></a><tt class="py-lineno">539</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt> <tt class="py-op">=</tt> <tt class="py-name">event_queue</tt> </tt>
<a name="L540"></a><tt class="py-lineno">540</tt>  <tt class="py-line">      <tt class="py-comment">#</tt> </tt>
<a name="L541"></a><tt class="py-lineno">541</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__interval</tt> <tt class="py-op">=</tt> <tt class="py-name">max</tt><tt class="py-op">(</tt><tt class="py-name">report_interval</tt><tt class="py-op">,</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt> </tt>
<a name="L542"></a><tt class="py-lineno">542</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__last_report</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L543"></a><tt class="py-lineno">543</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__last_processed</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L544"></a><tt class="py-lineno">544</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__only_periodic_iters</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L545"></a><tt class="py-lineno">545</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ktrace</tt> <tt class="py-op">=</tt> <tt class="py-name">ktrace</tt> </tt>
<a name="L546"></a><tt class="py-lineno">546</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__kmeta</tt> <tt class="py-op">=</tt> <tt class="py-name">kmeta</tt> </tt>
<a name="L547"></a><tt class="py-lineno">547</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L548"></a><tt class="py-lineno">548</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_fh</tt> <tt class="py-op">=</tt> <tt class="py-name">debug_fh</tt> </tt>
<a name="L549"></a><tt class="py-lineno">549</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_thresh</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L550"></a><tt class="py-lineno">550</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_cycle_count</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L551"></a><tt class="py-lineno">551</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">random</tt> <tt class="py-op">=</tt> <tt class="py-name">random</tt> </tt>
<a name="L552"></a><tt class="py-lineno">552</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">random</tt><tt class="py-op">.</tt><tt class="py-name">seed</tt><tt class="py-op">(</tt><tt class="py-name">rand_seed</tt><tt class="py-op">)</tt> </tt>
</div><a name="L553"></a><tt class="py-lineno">553</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.debug_trigger"></a><div id="Simulator.debug_trigger-def"><a name="L554"></a><tt class="py-lineno">554</tt> <a class="py-toggle" href="#" id="Simulator.debug_trigger-toggle" onclick="return toggle('Simulator.debug_trigger');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#debug_trigger">debug_trigger</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">on</tt><tt class="py-op">=</tt><tt class="py-name">True</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.debug_trigger-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.debug_trigger-expanded"><a name="L555"></a><tt class="py-lineno">555</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L556"></a><tt class="py-lineno">556</tt>  <tt class="py-line"><tt class="py-docstring">      Activates or deactivates debugging messages, which are sent to the</tt> </tt>
<a name="L557"></a><tt class="py-lineno">557</tt>  <tt class="py-line"><tt class="py-docstring">      debugging stream specified in the constructor.</tt> </tt>
<a name="L558"></a><tt class="py-lineno">558</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L559"></a><tt class="py-lineno">559</tt>  <tt class="py-line"><tt class="py-docstring">      @param on: Flag specifying whether or not debug messages are enabled</tt> </tt>
<a name="L560"></a><tt class="py-lineno">560</tt>  <tt class="py-line"><tt class="py-docstring">      @type on: bool</tt> </tt>
<a name="L561"></a><tt class="py-lineno">561</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L562"></a><tt class="py-lineno">562</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug</tt> <tt class="py-op">=</tt> <tt class="py-name">on</tt> </tt>
<a name="L563"></a><tt class="py-lineno">563</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug</tt><tt class="py-op">:</tt> </tt>
<a name="L564"></a><tt class="py-lineno">564</tt>  <tt class="py-line">         <tt class="py-keyword">print</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt><tt class="py-op">,</tt> <tt class="py-string">'*** DEBUG TRIGGERED ***'</tt> </tt>
</div><a name="L565"></a><tt class="py-lineno">565</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.set_auto_debug"></a><div id="Simulator.set_auto_debug-def"><a name="L566"></a><tt class="py-lineno">566</tt> <a class="py-toggle" href="#" id="Simulator.set_auto_debug-toggle" onclick="return toggle('Simulator.set_auto_debug');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#set_auto_debug">set_auto_debug</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">thresh</tt><tt class="py-op">=</tt><tt class="py-number">10000</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.set_auto_debug-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.set_auto_debug-expanded"><a name="L567"></a><tt class="py-lineno">567</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L568"></a><tt class="py-lineno">568</tt>  <tt class="py-line"><tt class="py-docstring">      Sets the automatic debugging trigger, which allows the simulator to</tt> </tt>
<a name="L569"></a><tt class="py-lineno">569</tt>  <tt class="py-line"><tt class="py-docstring">      activate debugging messages after a certain number of event loop</tt> </tt>
<a name="L570"></a><tt class="py-lineno">570</tt>  <tt class="py-line"><tt class="py-docstring">      iterations have executed, with only periodic events found in the queue.</tt> </tt>
<a name="L571"></a><tt class="py-lineno">571</tt>  <tt class="py-line"><tt class="py-docstring">      This mechanism is a heuristic to aid in the debugging of runaway</tt> </tt>
<a name="L572"></a><tt class="py-lineno">572</tt>  <tt class="py-line"><tt class="py-docstring">      simulations. Set the threshold value to a number less than 1 to</tt> </tt>
<a name="L573"></a><tt class="py-lineno">573</tt>  <tt class="py-line"><tt class="py-docstring">      deactivate the automatic trigger.</tt> </tt>
<a name="L574"></a><tt class="py-lineno">574</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L575"></a><tt class="py-lineno">575</tt>  <tt class="py-line"><tt class="py-docstring">      @param thresh: Debugging threshold value</tt> </tt>
<a name="L576"></a><tt class="py-lineno">576</tt>  <tt class="py-line"><tt class="py-docstring">      @type thresh: int</tt> </tt>
<a name="L577"></a><tt class="py-lineno">577</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L578"></a><tt class="py-lineno">578</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_thresh</tt> <tt class="py-op">=</tt> <tt class="py-name">thresh</tt> </tt>
<a name="L579"></a><tt class="py-lineno">579</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_cycle_count</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L580"></a><tt class="py-lineno">580</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
</div><a name="L581"></a><tt class="py-lineno">581</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.debug"></a><div id="Simulator.debug-def"><a name="L582"></a><tt class="py-lineno">582</tt> <a class="py-toggle" href="#" id="Simulator.debug-toggle" onclick="return toggle('Simulator.debug');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#debug">debug</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">message</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.debug-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.debug-expanded"><a name="L583"></a><tt class="py-lineno">583</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L584"></a><tt class="py-lineno">584</tt>  <tt class="py-line"><tt class="py-docstring">      Writes a message to the debug stream if debugging has been triggered.</tt> </tt>
<a name="L585"></a><tt class="py-lineno">585</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L586"></a><tt class="py-lineno">586</tt>  <tt class="py-line"><tt class="py-docstring">      @param message: Message to be written</tt> </tt>
<a name="L587"></a><tt class="py-lineno">587</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L588"></a><tt class="py-lineno">588</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug</tt><tt class="py-op">:</tt> </tt>
<a name="L589"></a><tt class="py-lineno">589</tt>  <tt class="py-line">         <tt class="py-keyword">print</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_fh</tt><tt class="py-op">,</tt> <tt class="py-string">'DEBUG:: '</tt><tt class="py-op">,</tt> <tt class="py-name">message</tt> </tt>
</div><a name="L590"></a><tt class="py-lineno">590</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.has_events"></a><div id="Simulator.has_events-def"><a name="L591"></a><tt class="py-lineno">591</tt> <a class="py-toggle" href="#" id="Simulator.has_events-toggle" onclick="return toggle('Simulator.has_events');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#has_events">has_events</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.has_events-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.has_events-expanded"><a name="L592"></a><tt class="py-lineno">592</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L593"></a><tt class="py-lineno">593</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: bool</tt> </tt>
<a name="L594"></a><tt class="py-lineno">594</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True iff the event queue is non-empty</tt> </tt>
<a name="L595"></a><tt class="py-lineno">595</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L596"></a><tt class="py-lineno">596</tt>  <tt class="py-line">      <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-15" class="py-name" targets="Method simvoc.core.kernel.EventQueue.has_events()=simvoc.core.kernel.EventQueue-class.html#has_events,Method simvoc.core.kernel.Simulator.has_events()=simvoc.core.kernel.Simulator-class.html#has_events"><a title="simvoc.core.kernel.EventQueue.has_events
simvoc.core.kernel.Simulator.has_events" class="py-name" href="#" onclick="return doclink('link-15', 'has_events', 'link-15');">has_events</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L597"></a><tt class="py-lineno">597</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L598"></a><tt class="py-lineno">598</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.has_regular_events"></a><div id="Simulator.has_regular_events-def"><a name="L599"></a><tt class="py-lineno">599</tt> <a class="py-toggle" href="#" id="Simulator.has_regular_events-toggle" onclick="return toggle('Simulator.has_regular_events');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#has_regular_events">has_regular_events</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.has_regular_events-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.has_regular_events-expanded"><a name="L600"></a><tt class="py-lineno">600</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L601"></a><tt class="py-lineno">601</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: bool</tt> </tt>
<a name="L602"></a><tt class="py-lineno">602</tt>  <tt class="py-line"><tt class="py-docstring">      @return: True iff the event queue contains at least one regular event.</tt> </tt>
<a name="L603"></a><tt class="py-lineno">603</tt>  <tt class="py-line"><tt class="py-docstring">      Periodic events will not be counted, allowing the client code to detect</tt> </tt>
<a name="L604"></a><tt class="py-lineno">604</tt>  <tt class="py-line"><tt class="py-docstring">      an "end of input" condition and cease scheduling periodic events.</tt> </tt>
<a name="L605"></a><tt class="py-lineno">605</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L606"></a><tt class="py-lineno">606</tt>  <tt class="py-line">      <tt class="py-name">result</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-16" class="py-name" targets="Method simvoc.core.kernel.EventQueue.has_regular_events()=simvoc.core.kernel.EventQueue-class.html#has_regular_events,Method simvoc.core.kernel.Simulator.has_regular_events()=simvoc.core.kernel.Simulator-class.html#has_regular_events"><a title="simvoc.core.kernel.EventQueue.has_regular_events
simvoc.core.kernel.Simulator.has_regular_events" class="py-name" href="#" onclick="return doclink('link-16', 'has_regular_events', 'link-16');">has_regular_events</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L607"></a><tt class="py-lineno">607</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">result</tt> </tt>
</div><a name="L608"></a><tt class="py-lineno">608</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.cancel_event"></a><div id="Simulator.cancel_event-def"><a name="L609"></a><tt class="py-lineno">609</tt> <a class="py-toggle" href="#" id="Simulator.cancel_event-toggle" onclick="return toggle('Simulator.cancel_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#cancel_event">cancel_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">evt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.cancel_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.cancel_event-expanded"><a name="L610"></a><tt class="py-lineno">610</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L611"></a><tt class="py-lineno">611</tt>  <tt class="py-line"><tt class="py-docstring">      Cancels a scheduled event that is waiting in the queue. If the event is</tt> </tt>
<a name="L612"></a><tt class="py-lineno">612</tt>  <tt class="py-line"><tt class="py-docstring">      not found in the queue, an Exception will be raised. Upon cancellation,</tt> </tt>
<a name="L613"></a><tt class="py-lineno">613</tt>  <tt class="py-line"><tt class="py-docstring">      the event will be marked as activated, so that periodic scheduling code</tt> </tt>
<a name="L614"></a><tt class="py-lineno">614</tt>  <tt class="py-line"><tt class="py-docstring">      behaves properly.</tt> </tt>
<a name="L615"></a><tt class="py-lineno">615</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L616"></a><tt class="py-lineno">616</tt>  <tt class="py-line"><tt class="py-docstring">      @param evt: Event to cancel</tt> </tt>
<a name="L617"></a><tt class="py-lineno">617</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L618"></a><tt class="py-lineno">618</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-17" class="py-name" targets="Method simvoc.core.kernel.EventQueue.cancel_event()=simvoc.core.kernel.EventQueue-class.html#cancel_event,Method simvoc.core.kernel.Simulator.cancel_event()=simvoc.core.kernel.Simulator-class.html#cancel_event"><a title="simvoc.core.kernel.EventQueue.cancel_event
simvoc.core.kernel.Simulator.cancel_event" class="py-name" href="#" onclick="return doclink('link-17', 'cancel_event', 'link-17');">cancel_event</a></tt><tt class="py-op">(</tt><tt class="py-name">evt</tt><tt class="py-op">)</tt> </tt>
</div><a name="L619"></a><tt class="py-lineno">619</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.add_event"></a><div id="Simulator.add_event-def"><a name="L620"></a><tt class="py-lineno">620</tt> <a class="py-toggle" href="#" id="Simulator.add_event-toggle" onclick="return toggle('Simulator.add_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#add_event">add_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">evt</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.add_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.add_event-expanded"><a name="L621"></a><tt class="py-lineno">621</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L622"></a><tt class="py-lineno">622</tt>  <tt class="py-line"><tt class="py-docstring">      Adds an event to the queue. Events must not specify an activation time</tt> </tt>
<a name="L623"></a><tt class="py-lineno">623</tt>  <tt class="py-line"><tt class="py-docstring">      earlier than the current simulated time, or a TimeTravelException will</tt> </tt>
<a name="L624"></a><tt class="py-lineno">624</tt>  <tt class="py-line"><tt class="py-docstring">      be raised.</tt> </tt>
<a name="L625"></a><tt class="py-lineno">625</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L626"></a><tt class="py-lineno">626</tt>  <tt class="py-line"><tt class="py-docstring">      @param evt: Event to be added to the queue</tt> </tt>
<a name="L627"></a><tt class="py-lineno">627</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L628"></a><tt class="py-lineno">628</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L629"></a><tt class="py-lineno">629</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L630"></a><tt class="py-lineno">630</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> <tt class="py-op">&lt;</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt><tt class="py-op">:</tt> </tt>
<a name="L631"></a><tt class="py-lineno">631</tt>  <tt class="py-line">         <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-string">'Tried to add event for time %d at time %d'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L632"></a><tt class="py-lineno">632</tt>  <tt class="py-line">               <tt class="py-op">(</tt><tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt><tt class="py-op">)</tt> </tt>
<a name="L633"></a><tt class="py-lineno">633</tt>  <tt class="py-line">         <tt class="py-keyword">raise</tt> <tt id="link-18" class="py-name" targets="Class simvoc.core.kernel.TimeTravelException=simvoc.core.kernel.TimeTravelException-class.html"><a title="simvoc.core.kernel.TimeTravelException" class="py-name" href="#" onclick="return doclink('link-18', 'TimeTravelException', 'link-18');">TimeTravelException</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L634"></a><tt class="py-lineno">634</tt>  <tt class="py-line">      <tt class="py-name">r</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-19" class="py-name"><a title="simvoc.core.kernel.EventQueue.add_event
simvoc.core.kernel.Simulator.add_event" class="py-name" href="#" onclick="return doclink('link-19', 'add_event', 'link-7');">add_event</a></tt><tt class="py-op">(</tt><tt class="py-name">evt</tt><tt class="py-op">)</tt> </tt>
<a name="L635"></a><tt class="py-lineno">635</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">r</tt> </tt>
</div><a name="L636"></a><tt class="py-lineno">636</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.new_event"></a><div id="Simulator.new_event-def"><a name="L637"></a><tt class="py-lineno">637</tt> <a class="py-toggle" href="#" id="Simulator.new_event-toggle" onclick="return toggle('Simulator.new_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#new_event">new_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">regular</tt><tt class="py-op">,</tt> <tt class="py-param">extern</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.new_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.new_event-expanded"><a name="L638"></a><tt class="py-lineno">638</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L639"></a><tt class="py-lineno">639</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new event</tt> </tt>
<a name="L640"></a><tt class="py-lineno">640</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L641"></a><tt class="py-lineno">641</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L642"></a><tt class="py-lineno">642</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L643"></a><tt class="py-lineno">643</tt>  <tt class="py-line"><tt class="py-docstring">      @param regular: specifies whether event is regular or periodic</tt> </tt>
<a name="L644"></a><tt class="py-lineno">644</tt>  <tt class="py-line"><tt class="py-docstring">      @type regular: bool</tt> </tt>
<a name="L645"></a><tt class="py-lineno">645</tt>  <tt class="py-line"><tt class="py-docstring">      @param extern: specifies whether event is external to the simulator or</tt> </tt>
<a name="L646"></a><tt class="py-lineno">646</tt>  <tt class="py-line"><tt class="py-docstring">                     is simulator-aware</tt> </tt>
<a name="L647"></a><tt class="py-lineno">647</tt>  <tt class="py-line"><tt class="py-docstring">      @type extern: bool</tt> </tt>
<a name="L648"></a><tt class="py-lineno">648</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L649"></a><tt class="py-lineno">649</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L650"></a><tt class="py-lineno">650</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L651"></a><tt class="py-lineno">651</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L652"></a><tt class="py-lineno">652</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L653"></a><tt class="py-lineno">653</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L654"></a><tt class="py-lineno">654</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">act_time</tt> <tt class="py-op">&lt;</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt><tt class="py-op">:</tt> </tt>
<a name="L655"></a><tt class="py-lineno">655</tt>  <tt class="py-line">         <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-string">'Tried to add event for time %d at time %d'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L656"></a><tt class="py-lineno">656</tt>  <tt class="py-line">               <tt class="py-op">(</tt><tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt><tt class="py-op">)</tt> </tt>
<a name="L657"></a><tt class="py-lineno">657</tt>  <tt class="py-line">         <tt class="py-keyword">raise</tt> <tt id="link-20" class="py-name"><a title="simvoc.core.kernel.TimeTravelException" class="py-name" href="#" onclick="return doclink('link-20', 'TimeTravelException', 'link-18');">TimeTravelException</a></tt><tt class="py-op">(</tt><tt class="py-name">msg</tt><tt class="py-op">)</tt> </tt>
<a name="L658"></a><tt class="py-lineno">658</tt>  <tt class="py-line">      <tt class="py-name">r</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-21" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_event
simvoc.core.kernel.Simulator.new_event" class="py-name" href="#" onclick="return doclink('link-21', 'new_event', 'link-8');">new_event</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">,</tt> <tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">regular</tt><tt class="py-op">,</tt> <tt class="py-name">extern</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> \ </tt>
<a name="L659"></a><tt class="py-lineno">659</tt>  <tt class="py-line">                                     <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
<a name="L660"></a><tt class="py-lineno">660</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">r</tt> </tt>
</div><a name="L661"></a><tt class="py-lineno">661</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.new_simple_event"></a><div id="Simulator.new_simple_event-def"><a name="L662"></a><tt class="py-lineno">662</tt> <a class="py-toggle" href="#" id="Simulator.new_simple_event-toggle" onclick="return toggle('Simulator.new_simple_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#new_simple_event">new_simple_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.new_simple_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.new_simple_event-expanded"><a name="L663"></a><tt class="py-lineno">663</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L664"></a><tt class="py-lineno">664</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new REGULAR event that invokes a</tt> </tt>
<a name="L665"></a><tt class="py-lineno">665</tt>  <tt class="py-line"><tt class="py-docstring">      simulator-aware (non-external) function. The first two arguments to</tt> </tt>
<a name="L666"></a><tt class="py-lineno">666</tt>  <tt class="py-line"><tt class="py-docstring">      the function will be the current simulated time and a reference to</tt> </tt>
<a name="L667"></a><tt class="py-lineno">667</tt>  <tt class="py-line"><tt class="py-docstring">      the Simulator itself.</tt> </tt>
<a name="L668"></a><tt class="py-lineno">668</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L669"></a><tt class="py-lineno">669</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L670"></a><tt class="py-lineno">670</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L671"></a><tt class="py-lineno">671</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L672"></a><tt class="py-lineno">672</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L673"></a><tt class="py-lineno">673</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L674"></a><tt class="py-lineno">674</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L675"></a><tt class="py-lineno">675</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L676"></a><tt class="py-lineno">676</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L677"></a><tt class="py-lineno">677</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-22" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_event
simvoc.core.kernel.Simulator.new_event" class="py-name" href="#" onclick="return doclink('link-22', 'new_event', 'link-8');">new_event</a></tt><tt class="py-op">(</tt><tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
</div><a name="L678"></a><tt class="py-lineno">678</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.new_periodic_event"></a><div id="Simulator.new_periodic_event-def"><a name="L679"></a><tt class="py-lineno">679</tt> <a class="py-toggle" href="#" id="Simulator.new_periodic_event-toggle" onclick="return toggle('Simulator.new_periodic_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#new_periodic_event">new_periodic_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.new_periodic_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.new_periodic_event-expanded"><a name="L680"></a><tt class="py-lineno">680</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L681"></a><tt class="py-lineno">681</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new PERIODIC event that invokes a</tt> </tt>
<a name="L682"></a><tt class="py-lineno">682</tt>  <tt class="py-line"><tt class="py-docstring">      simulator-aware (non-external) function. The first two arguments to</tt> </tt>
<a name="L683"></a><tt class="py-lineno">683</tt>  <tt class="py-line"><tt class="py-docstring">      the function will be the current simulated time and a reference to</tt> </tt>
<a name="L684"></a><tt class="py-lineno">684</tt>  <tt class="py-line"><tt class="py-docstring">      the Simulator itself.</tt> </tt>
<a name="L685"></a><tt class="py-lineno">685</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L686"></a><tt class="py-lineno">686</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L687"></a><tt class="py-lineno">687</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L688"></a><tt class="py-lineno">688</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L689"></a><tt class="py-lineno">689</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L690"></a><tt class="py-lineno">690</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L691"></a><tt class="py-lineno">691</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L692"></a><tt class="py-lineno">692</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L693"></a><tt class="py-lineno">693</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L694"></a><tt class="py-lineno">694</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-23" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_event
simvoc.core.kernel.Simulator.new_event" class="py-name" href="#" onclick="return doclink('link-23', 'new_event', 'link-8');">new_event</a></tt><tt class="py-op">(</tt><tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">False</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
</div><a name="L695"></a><tt class="py-lineno">695</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.new_external_event"></a><div id="Simulator.new_external_event-def"><a name="L696"></a><tt class="py-lineno">696</tt> <a class="py-toggle" href="#" id="Simulator.new_external_event-toggle" onclick="return toggle('Simulator.new_external_event');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#new_external_event">new_external_event</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">act_time</tt><tt class="py-op">,</tt> <tt class="py-param">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-param">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-param">kwds</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.new_external_event-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.new_external_event-expanded"><a name="L697"></a><tt class="py-lineno">697</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L698"></a><tt class="py-lineno">698</tt>  <tt class="py-line"><tt class="py-docstring">      Creates and schedules a new REGULAR event that invokes an EXTERNAL</tt> </tt>
<a name="L699"></a><tt class="py-lineno">699</tt>  <tt class="py-line"><tt class="py-docstring">      (non simulator-aware) function. The current time and simulator</tt> </tt>
<a name="L700"></a><tt class="py-lineno">700</tt>  <tt class="py-line"><tt class="py-docstring">      reference will NOT be passed to the function.</tt> </tt>
<a name="L701"></a><tt class="py-lineno">701</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L702"></a><tt class="py-lineno">702</tt>  <tt class="py-line"><tt class="py-docstring">      @param act_time: Event activation time</tt> </tt>
<a name="L703"></a><tt class="py-lineno">703</tt>  <tt class="py-line"><tt class="py-docstring">      @type act_time: number</tt> </tt>
<a name="L704"></a><tt class="py-lineno">704</tt>  <tt class="py-line"><tt class="py-docstring">      @param fn: Function to be called when the event activates</tt> </tt>
<a name="L705"></a><tt class="py-lineno">705</tt>  <tt class="py-line"><tt class="py-docstring">      @param args: Arguments to be passed (in order) to the function</tt> </tt>
<a name="L706"></a><tt class="py-lineno">706</tt>  <tt class="py-line"><tt class="py-docstring">      @param kwds: Keywods to be passed to the function</tt> </tt>
<a name="L707"></a><tt class="py-lineno">707</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L708"></a><tt class="py-lineno">708</tt>  <tt class="py-line"><tt class="py-docstring">      @return: reference to the newly added event</tt> </tt>
<a name="L709"></a><tt class="py-lineno">709</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L710"></a><tt class="py-lineno">710</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-24" class="py-name"><a title="simvoc.core.kernel.EventQueue.new_event
simvoc.core.kernel.Simulator.new_event" class="py-name" href="#" onclick="return doclink('link-24', 'new_event', 'link-8');">new_event</a></tt><tt class="py-op">(</tt><tt class="py-name">act_time</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">True</tt><tt class="py-op">,</tt> <tt class="py-name">fn</tt><tt class="py-op">,</tt> <tt class="py-op">*</tt><tt class="py-name">args</tt><tt class="py-op">,</tt> <tt class="py-op">**</tt><tt class="py-name">kwds</tt><tt class="py-op">)</tt> </tt>
</div><a name="L711"></a><tt class="py-lineno">711</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.get_queue_size"></a><div id="Simulator.get_queue_size-def"><a name="L712"></a><tt class="py-lineno">712</tt> <a class="py-toggle" href="#" id="Simulator.get_queue_size-toggle" onclick="return toggle('Simulator.get_queue_size');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#get_queue_size">get_queue_size</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.get_queue_size-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.get_queue_size-expanded"><a name="L713"></a><tt class="py-lineno">713</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L714"></a><tt class="py-lineno">714</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: int</tt> </tt>
<a name="L715"></a><tt class="py-lineno">715</tt>  <tt class="py-line"><tt class="py-docstring">      @return: current queue size as viewed externally (i.e. add 1 if an event</tt> </tt>
<a name="L716"></a><tt class="py-lineno">716</tt>  <tt class="py-line"><tt class="py-docstring">      is currently processing, even though that event has been removed from the</tt> </tt>
<a name="L717"></a><tt class="py-lineno">717</tt>  <tt class="py-line"><tt class="py-docstring">      actual queue structure)</tt> </tt>
<a name="L718"></a><tt class="py-lineno">718</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L719"></a><tt class="py-lineno">719</tt>  <tt class="py-line">      <tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-25" class="py-name" targets="Method simvoc.core.kernel.EventQueue.get_size()=simvoc.core.kernel.EventQueue-class.html#get_size"><a title="simvoc.core.kernel.EventQueue.get_size" class="py-name" href="#" onclick="return doclink('link-25', 'get_size', 'link-25');">get_size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L720"></a><tt class="py-lineno">720</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_running</tt><tt class="py-op">:</tt> </tt>
<a name="L721"></a><tt class="py-lineno">721</tt>  <tt class="py-line">         <tt class="py-name">size</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L722"></a><tt class="py-lineno">722</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">size</tt> </tt>
</div><a name="L723"></a><tt class="py-lineno">723</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.get_waiting_size"></a><div id="Simulator.get_waiting_size-def"><a name="L724"></a><tt class="py-lineno">724</tt> <a class="py-toggle" href="#" id="Simulator.get_waiting_size-toggle" onclick="return toggle('Simulator.get_waiting_size');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#get_waiting_size">get_waiting_size</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.get_waiting_size-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.get_waiting_size-expanded"><a name="L725"></a><tt class="py-lineno">725</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L726"></a><tt class="py-lineno">726</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: int</tt> </tt>
<a name="L727"></a><tt class="py-lineno">727</tt>  <tt class="py-line"><tt class="py-docstring">      @return: current number of events waiting in the event queue, not</tt> </tt>
<a name="L728"></a><tt class="py-lineno">728</tt>  <tt class="py-line"><tt class="py-docstring">      counting any event that is currently processing</tt> </tt>
<a name="L729"></a><tt class="py-lineno">729</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L730"></a><tt class="py-lineno">730</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-26" class="py-name"><a title="simvoc.core.kernel.EventQueue.get_size" class="py-name" href="#" onclick="return doclink('link-26', 'get_size', 'link-25');">get_size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L731"></a><tt class="py-lineno">731</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.get_status"></a><div id="Simulator.get_status-def"><a name="L732"></a><tt class="py-lineno">732</tt> <a class="py-toggle" href="#" id="Simulator.get_status-toggle" onclick="return toggle('Simulator.get_status');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#get_status">get_status</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.get_status-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.get_status-expanded"><a name="L733"></a><tt class="py-lineno">733</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L734"></a><tt class="py-lineno">734</tt>  <tt class="py-line"><tt class="py-docstring">      @return: a tuple (time, queue_size, num_processed) with status</tt> </tt>
<a name="L735"></a><tt class="py-lineno">735</tt>  <tt class="py-line"><tt class="py-docstring">      information (current time, current queue size as viewed externally,</tt> </tt>
<a name="L736"></a><tt class="py-lineno">736</tt>  <tt class="py-line"><tt class="py-docstring">      and total number of events processed)</tt> </tt>
<a name="L737"></a><tt class="py-lineno">737</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L738"></a><tt class="py-lineno">738</tt>  <tt class="py-line">      <tt class="py-name">time</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> </tt>
<a name="L739"></a><tt class="py-lineno">739</tt>  <tt class="py-line">      <tt class="py-name">size</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-27" class="py-name" targets="Method simvoc.core.kernel.Simulator.get_queue_size()=simvoc.core.kernel.Simulator-class.html#get_queue_size"><a title="simvoc.core.kernel.Simulator.get_queue_size" class="py-name" href="#" onclick="return doclink('link-27', 'get_queue_size', 'link-27');">get_queue_size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L740"></a><tt class="py-lineno">740</tt>  <tt class="py-line">      <tt class="py-name">processed</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt> </tt>
<a name="L741"></a><tt class="py-lineno">741</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">time</tt><tt class="py-op">,</tt> <tt class="py-name">size</tt><tt class="py-op">,</tt> <tt class="py-name">processed</tt><tt class="py-op">)</tt> </tt>
</div><a name="L742"></a><tt class="py-lineno">742</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.get_output_handler"></a><div id="Simulator.get_output_handler-def"><a name="L743"></a><tt class="py-lineno">743</tt> <a class="py-toggle" href="#" id="Simulator.get_output_handler-toggle" onclick="return toggle('Simulator.get_output_handler');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#get_output_handler">get_output_handler</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.get_output_handler-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.get_output_handler-expanded"><a name="L744"></a><tt class="py-lineno">744</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L745"></a><tt class="py-lineno">745</tt>  <tt class="py-line"><tt class="py-docstring">      @return: a reference to the output handler to which results are sent. If</tt> </tt>
<a name="L746"></a><tt class="py-lineno">746</tt>  <tt class="py-line"><tt class="py-docstring">      a pipeline of output handlers is used, the return value will be a</tt> </tt>
<a name="L747"></a><tt class="py-lineno">747</tt>  <tt class="py-line"><tt class="py-docstring">      reference to the first handler in the pipeline.</tt> </tt>
<a name="L748"></a><tt class="py-lineno">748</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L749"></a><tt class="py-lineno">749</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__results</tt> </tt>
</div><a name="L750"></a><tt class="py-lineno">750</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.get_stats"></a><div id="Simulator.get_stats-def"><a name="L751"></a><tt class="py-lineno">751</tt> <a class="py-toggle" href="#" id="Simulator.get_stats-toggle" onclick="return toggle('Simulator.get_stats');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#get_stats">get_stats</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.get_stats-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.get_stats-expanded"><a name="L752"></a><tt class="py-lineno">752</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L753"></a><tt class="py-lineno">753</tt>  <tt class="py-line"><tt class="py-docstring">      @return: a tuple of statistics: (processed, walltime), where processed</tt> </tt>
<a name="L754"></a><tt class="py-lineno">754</tt>  <tt class="py-line"><tt class="py-docstring">      is the total number of events processed, and walltime is the elapsed</tt> </tt>
<a name="L755"></a><tt class="py-lineno">755</tt>  <tt class="py-line"><tt class="py-docstring">      actual time from simulation start to completion. This method is intended</tt> </tt>
<a name="L756"></a><tt class="py-lineno">756</tt>  <tt class="py-line"><tt class="py-docstring">      to be called only after the simulator main loop has finished.</tt> </tt>
<a name="L757"></a><tt class="py-lineno">757</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L758"></a><tt class="py-lineno">758</tt>  <tt class="py-line">      <tt class="py-name">processed</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt> </tt>
<a name="L759"></a><tt class="py-lineno">759</tt>  <tt class="py-line">      <tt class="py-name">walltime</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__exec_time</tt> </tt>
<a name="L760"></a><tt class="py-lineno">760</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">processed</tt><tt class="py-op">,</tt> <tt class="py-name">walltime</tt><tt class="py-op">)</tt> </tt>
</div><a name="L761"></a><tt class="py-lineno">761</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.get_time"></a><div id="Simulator.get_time-def"><a name="L762"></a><tt class="py-lineno">762</tt> <a class="py-toggle" href="#" id="Simulator.get_time-toggle" onclick="return toggle('Simulator.get_time');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#get_time">get_time</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.get_time-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.get_time-expanded"><a name="L763"></a><tt class="py-lineno">763</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L764"></a><tt class="py-lineno">764</tt>  <tt class="py-line"><tt class="py-docstring">      @rtype: number</tt> </tt>
<a name="L765"></a><tt class="py-lineno">765</tt>  <tt class="py-line"><tt class="py-docstring">      @return: current simulated time</tt> </tt>
<a name="L766"></a><tt class="py-lineno">766</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L767"></a><tt class="py-lineno">767</tt>  <tt class="py-line">      <tt class="py-name">xtime</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> </tt>
<a name="L768"></a><tt class="py-lineno">768</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-name">xtime</tt> </tt>
</div><a name="L769"></a><tt class="py-lineno">769</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.get_timestamp"></a><div id="Simulator.get_timestamp-def"><a name="L770"></a><tt class="py-lineno">770</tt> <a class="py-toggle" href="#" id="Simulator.get_timestamp-toggle" onclick="return toggle('Simulator.get_timestamp');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#get_timestamp">get_timestamp</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.get_timestamp-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.get_timestamp-expanded"><a name="L771"></a><tt class="py-lineno">771</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L772"></a><tt class="py-lineno">772</tt>  <tt class="py-line"><tt class="py-docstring">      @return: a tuple containing the current simulated time: (actual, relative)</tt> </tt>
<a name="L773"></a><tt class="py-lineno">773</tt>  <tt class="py-line"><tt class="py-docstring">      where actual is the current time (as reported by the get_time() method)</tt> </tt>
<a name="L774"></a><tt class="py-lineno">774</tt>  <tt class="py-line"><tt class="py-docstring">      and relative is the simulated time elapsed from the current time and</tt> </tt>
<a name="L775"></a><tt class="py-lineno">775</tt>  <tt class="py-line"><tt class="py-docstring">      starting clock time. These values will be identical when the starting</tt> </tt>
<a name="L776"></a><tt class="py-lineno">776</tt>  <tt class="py-line"><tt class="py-docstring">      clock time is zero.</tt> </tt>
<a name="L777"></a><tt class="py-lineno">777</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L778"></a><tt class="py-lineno">778</tt>  <tt class="py-line">      <tt class="py-name">xtime</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> </tt>
<a name="L779"></a><tt class="py-lineno">779</tt>  <tt class="py-line">      <tt class="py-name">rtime</tt> <tt class="py-op">=</tt> <tt class="py-name">xtime</tt> <tt class="py-op">-</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__start_clock</tt> </tt>
<a name="L780"></a><tt class="py-lineno">780</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">xtime</tt><tt class="py-op">,</tt> <tt class="py-name">rtime</tt><tt class="py-op">)</tt> </tt>
</div><a name="L781"></a><tt class="py-lineno">781</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.set_start_clock"></a><div id="Simulator.set_start_clock-def"><a name="L782"></a><tt class="py-lineno">782</tt> <a class="py-toggle" href="#" id="Simulator.set_start_clock-toggle" onclick="return toggle('Simulator.set_start_clock');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#set_start_clock">set_start_clock</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">clock</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.set_start_clock-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.set_start_clock-expanded"><a name="L783"></a><tt class="py-lineno">783</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L784"></a><tt class="py-lineno">784</tt>  <tt class="py-line"><tt class="py-docstring">      Sets the simulator start clock after object creation. This method may be</tt> </tt>
<a name="L785"></a><tt class="py-lineno">785</tt>  <tt class="py-line"><tt class="py-docstring">      called only before the simulator has been started, or an Exception will</tt> </tt>
<a name="L786"></a><tt class="py-lineno">786</tt>  <tt class="py-line"><tt class="py-docstring">      be raised. The activation times of any events already in the queue will</tt> </tt>
<a name="L787"></a><tt class="py-lineno">787</tt>  <tt class="py-line"><tt class="py-docstring">      be adjusted according to the new clock setting.</tt> </tt>
<a name="L788"></a><tt class="py-lineno">788</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L789"></a><tt class="py-lineno">789</tt>  <tt class="py-line"><tt class="py-docstring">      @param clock: New simulation start time</tt> </tt>
<a name="L790"></a><tt class="py-lineno">790</tt>  <tt class="py-line"><tt class="py-docstring">      @type clock: number</tt> </tt>
<a name="L791"></a><tt class="py-lineno">791</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L792"></a><tt class="py-lineno">792</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__started</tt><tt class="py-op">:</tt> </tt>
<a name="L793"></a><tt class="py-lineno">793</tt>  <tt class="py-line">         <tt class="py-keyword">raise</tt> <tt class="py-name">Exception</tt><tt class="py-op">(</tt><tt class="py-string">'Simulation has started'</tt><tt class="py-op">)</tt> </tt>
<a name="L794"></a><tt class="py-lineno">794</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__start_clock</tt> <tt class="py-op">=</tt> <tt class="py-name">clock</tt> </tt>
<a name="L795"></a><tt class="py-lineno">795</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> <tt class="py-op">=</tt> <tt class="py-name">clock</tt> </tt>
<a name="L796"></a><tt class="py-lineno">796</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-28" class="py-name" targets="Method simvoc.core.kernel.EventQueue.adjust_events()=simvoc.core.kernel.EventQueue-class.html#adjust_events"><a title="simvoc.core.kernel.EventQueue.adjust_events" class="py-name" href="#" onclick="return doclink('link-28', 'adjust_events', 'link-28');">adjust_events</a></tt><tt class="py-op">(</tt><tt class="py-name">clock</tt><tt class="py-op">)</tt> </tt>
</div><a name="L797"></a><tt class="py-lineno">797</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.add_result"></a><div id="Simulator.add_result-def"><a name="L798"></a><tt class="py-lineno">798</tt> <a class="py-toggle" href="#" id="Simulator.add_result-toggle" onclick="return toggle('Simulator.add_result');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#add_result">add_result</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">,</tt> <tt class="py-param">result</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.add_result-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.add_result-expanded"><a name="L799"></a><tt class="py-lineno">799</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L800"></a><tt class="py-lineno">800</tt>  <tt class="py-line"><tt class="py-docstring">      Sends a result to the output handler. Results may be stand-alone</tt> </tt>
<a name="L801"></a><tt class="py-lineno">801</tt>  <tt class="py-line"><tt class="py-docstring">      objects (or primitives) or collections, where is a collection of results</tt> </tt>
<a name="L802"></a><tt class="py-lineno">802</tt>  <tt class="py-line"><tt class="py-docstring">      is a 1-tuple containing a list or tuple of results. Collections may be</tt> </tt>
<a name="L803"></a><tt class="py-lineno">803</tt>  <tt class="py-line"><tt class="py-docstring">      nested.</tt> </tt>
<a name="L804"></a><tt class="py-lineno">804</tt>  <tt class="py-line"><tt class="py-docstring"></tt> </tt>
<a name="L805"></a><tt class="py-lineno">805</tt>  <tt class="py-line"><tt class="py-docstring">      @param result: Result or collection to send to the output handler</tt> </tt>
<a name="L806"></a><tt class="py-lineno">806</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L807"></a><tt class="py-lineno">807</tt>  <tt class="py-line">      <tt class="py-keyword">if</tt> <tt class="py-name">result</tt> <tt class="py-op">!=</tt> <tt class="py-name">None</tt><tt class="py-op">:</tt> </tt>
<a name="L808"></a><tt class="py-lineno">808</tt>  <tt class="py-line">         <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> <tt class="py-keyword">is</tt> <tt class="py-name">tuple</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">len</tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> <tt class="py-op">==</tt> <tt class="py-number">1</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L809"></a><tt class="py-lineno">809</tt>  <tt class="py-line">            <tt class="py-name">item</tt> <tt class="py-op">=</tt> <tt class="py-name">result</tt><tt class="py-op">[</tt><tt class="py-number">0</tt><tt class="py-op">]</tt> </tt>
<a name="L810"></a><tt class="py-lineno">810</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">type</tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> <tt class="py-keyword">in</tt> <tt class="py-op">(</tt><tt class="py-name">tuple</tt><tt class="py-op">,</tt> <tt class="py-name">list</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L811"></a><tt class="py-lineno">811</tt>  <tt class="py-line">               <tt class="py-keyword">for</tt> <tt class="py-name">n</tt> <tt class="py-keyword">in</tt> <tt class="py-name">item</tt><tt class="py-op">:</tt> </tt>
<a name="L812"></a><tt class="py-lineno">812</tt>  <tt class="py-line">                  <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-29" class="py-name" targets="Method simvoc.core.kernel.Simulator.add_result()=simvoc.core.kernel.Simulator-class.html#add_result"><a title="simvoc.core.kernel.Simulator.add_result" class="py-name" href="#" onclick="return doclink('link-29', 'add_result', 'link-29');">add_result</a></tt><tt class="py-op">(</tt><tt class="py-name">n</tt><tt class="py-op">)</tt> </tt>
<a name="L813"></a><tt class="py-lineno">813</tt>  <tt class="py-line">            <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L814"></a><tt class="py-lineno">814</tt>  <tt class="py-line">               <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__results</tt><tt class="py-op">.</tt><tt id="link-30" class="py-name"><a title="simvoc.core.duplicate_filter.DuplicateFilter.append
simvoc.core.filter_results.ResultFilter.append
simvoc.core.kernel.Output.append" class="py-name" href="#" onclick="return doclink('link-30', 'append', 'link-1');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">item</tt><tt class="py-op">)</tt> </tt>
<a name="L815"></a><tt class="py-lineno">815</tt>  <tt class="py-line">         <tt class="py-keyword">else</tt><tt class="py-op">:</tt> </tt>
<a name="L816"></a><tt class="py-lineno">816</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__results</tt><tt class="py-op">.</tt><tt id="link-31" class="py-name"><a title="simvoc.core.duplicate_filter.DuplicateFilter.append
simvoc.core.filter_results.ResultFilter.append
simvoc.core.kernel.Output.append" class="py-name" href="#" onclick="return doclink('link-31', 'append', 'link-1');">append</a></tt><tt class="py-op">(</tt><tt class="py-name">result</tt><tt class="py-op">)</tt> </tt>
</div><a name="L817"></a><tt class="py-lineno">817</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="Simulator.run"></a><div id="Simulator.run-def"><a name="L818"></a><tt class="py-lineno">818</tt> <a class="py-toggle" href="#" id="Simulator.run-toggle" onclick="return toggle('Simulator.run');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel.Simulator-class.html#run">run</a><tt class="py-op">(</tt><tt class="py-param">self</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="Simulator.run-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="Simulator.run-expanded"><a name="L819"></a><tt class="py-lineno">819</tt>  <tt class="py-line">      <tt class="py-docstring">'''</tt> </tt>
<a name="L820"></a><tt class="py-lineno">820</tt>  <tt class="py-line"><tt class="py-docstring">      Runs the main event loop and carries out the simulation. This method is</tt> </tt>
<a name="L821"></a><tt class="py-lineno">821</tt>  <tt class="py-line"><tt class="py-docstring">      synchronous and will not return until the simulation finishes.</tt> </tt>
<a name="L822"></a><tt class="py-lineno">822</tt>  <tt class="py-line"><tt class="py-docstring">      '''</tt> </tt>
<a name="L823"></a><tt class="py-lineno">823</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__started</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L824"></a><tt class="py-lineno">824</tt>  <tt class="py-line">      <tt class="py-keyword">print</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt><tt class="py-op">,</tt> <tt class="py-string">'Starting simulation at clock:'</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> </tt>
<a name="L825"></a><tt class="py-lineno">825</tt>  <tt class="py-line">      <tt class="py-name">start_time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L826"></a><tt class="py-lineno">826</tt>  <tt class="py-line">      <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ktrace</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-32" class="py-name" targets="Method simvoc.core.kernel.Simulator.get_timestamp()=simvoc.core.kernel.Simulator-class.html#get_timestamp"><a title="simvoc.core.kernel.Simulator.get_timestamp" class="py-name" href="#" onclick="return doclink('link-32', 'get_timestamp', 'link-32');">get_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">start_time</tt><tt class="py-op">,</tt> <tt class="py-string">'start simulation'</tt><tt class="py-op">,</tt> \ </tt>
<a name="L827"></a><tt class="py-lineno">827</tt>  <tt class="py-line">                    <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-33" class="py-name"><a title="simvoc.core.kernel.Simulator.get_queue_size" class="py-name" href="#" onclick="return doclink('link-33', 'get_queue_size', 'link-27');">get_queue_size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L828"></a><tt class="py-lineno">828</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-34" class="py-name"><a title="simvoc.core.kernel.Simulator.add_result" class="py-name" href="#" onclick="return doclink('link-34', 'add_result', 'link-29');">add_result</a></tt><tt class="py-op">(</tt><tt class="py-name">t</tt><tt class="py-op">)</tt> </tt>
<a name="L829"></a><tt class="py-lineno">829</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__last_report</tt> <tt class="py-op">=</tt> <tt class="py-name">start_time</tt> </tt>
<a name="L830"></a><tt class="py-lineno">830</tt>  <tt class="py-line">      <tt class="py-name">cur_size</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L831"></a><tt class="py-lineno">831</tt>  <tt class="py-line">      <tt class="py-name">last_size</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L832"></a><tt class="py-lineno">832</tt>  <tt class="py-line">      <tt class="py-keyword">while</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-35" class="py-name"><a title="simvoc.core.kernel.EventQueue.has_events
simvoc.core.kernel.Simulator.has_events" class="py-name" href="#" onclick="return doclink('link-35', 'has_events', 'link-15');">has_events</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L833"></a><tt class="py-lineno">833</tt>  <tt class="py-line">         <tt class="py-name">evt</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_queue</tt><tt class="py-op">.</tt><tt id="link-36" class="py-name" targets="Method simvoc.core.kernel.EventQueue.pop()=simvoc.core.kernel.EventQueue-class.html#pop"><a title="simvoc.core.kernel.EventQueue.pop" class="py-name" href="#" onclick="return doclink('link-36', 'pop', 'link-36');">pop</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L834"></a><tt class="py-lineno">834</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> <tt class="py-op">=</tt> <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt class="py-name">time</tt> </tt>
<a name="L835"></a><tt class="py-lineno">835</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_running</tt> <tt class="py-op">=</tt> <tt class="py-name">True</tt> </tt>
<a name="L836"></a><tt class="py-lineno">836</tt>  <tt class="py-line">         <tt class="py-name">data</tt> <tt class="py-op">=</tt> <tt class="py-name">evt</tt><tt class="py-op">.</tt><tt id="link-37" class="py-name" targets="Method simvoc.core.kernel.Event.activate()=simvoc.core.kernel.Event-class.html#activate"><a title="simvoc.core.kernel.Event.activate" class="py-name" href="#" onclick="return doclink('link-37', 'activate', 'link-37');">activate</a></tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">)</tt> </tt>
<a name="L837"></a><tt class="py-lineno">837</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__evt_running</tt> <tt class="py-op">=</tt> <tt class="py-name">False</tt> </tt>
<a name="L838"></a><tt class="py-lineno">838</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L839"></a><tt class="py-lineno">839</tt>  <tt class="py-line">         <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-38" class="py-name"><a title="simvoc.core.kernel.Simulator.add_result" class="py-name" href="#" onclick="return doclink('link-38', 'add_result', 'link-29');">add_result</a></tt><tt class="py-op">(</tt><tt class="py-name">data</tt><tt class="py-op">)</tt> </tt>
<a name="L840"></a><tt class="py-lineno">840</tt>  <tt class="py-line">         <tt class="py-name">cur_time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L841"></a><tt class="py-lineno">841</tt>  <tt class="py-line">         <tt class="py-keyword">if</tt> <tt class="py-op">(</tt><tt class="py-name">cur_time</tt> <tt class="py-op">-</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__last_report</tt><tt class="py-op">)</tt> <tt class="py-op">&gt;</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__interval</tt><tt class="py-op">:</tt> </tt>
<a name="L842"></a><tt class="py-lineno">842</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__last_report</tt> <tt class="py-op">=</tt> <tt class="py-name">cur_time</tt> </tt>
<a name="L843"></a><tt class="py-lineno">843</tt>  <tt class="py-line">            <tt class="py-name">last_size</tt> <tt class="py-op">=</tt> <tt class="py-name">cur_size</tt> </tt>
<a name="L844"></a><tt class="py-lineno">844</tt>  <tt class="py-line">            <tt class="py-name">cur_size</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-39" class="py-name"><a title="simvoc.core.kernel.Simulator.get_queue_size" class="py-name" href="#" onclick="return doclink('link-39', 'get_queue_size', 'link-27');">get_queue_size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L845"></a><tt class="py-lineno">845</tt>  <tt class="py-line">            <tt class="py-name">total</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt> <tt class="py-op">-</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__last_processed</tt> </tt>
<a name="L846"></a><tt class="py-lineno">846</tt>  <tt class="py-line">            <tt class="py-name">delta_q</tt> <tt class="py-op">=</tt> <tt class="py-name">cur_size</tt> <tt class="py-op">-</tt> <tt class="py-name">last_size</tt> </tt>
<a name="L847"></a><tt class="py-lineno">847</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__last_processed</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt> </tt>
<a name="L848"></a><tt class="py-lineno">848</tt>  <tt class="py-line">            <tt class="py-name">rate</tt> <tt class="py-op">=</tt> <tt class="py-name">total</tt> <tt class="py-op">/</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__interval</tt> </tt>
<a name="L849"></a><tt class="py-lineno">849</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">:</tt> </tt>
<a name="L850"></a><tt class="py-lineno">850</tt>  <tt class="py-line">               <tt class="py-name">msg</tt> <tt class="py-op">=</tt> <tt class="py-string">'Clock: %d  Queue size: %d  Events: %d (%d events/sec)'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L851"></a><tt class="py-lineno">851</tt>  <tt class="py-line">                  <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__clock</tt><tt class="py-op">,</tt> <tt class="py-name">cur_size</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt><tt class="py-op">,</tt> <tt class="py-name">rate</tt><tt class="py-op">)</tt> </tt>
<a name="L852"></a><tt class="py-lineno">852</tt>  <tt class="py-line">               <tt class="py-keyword">print</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt> </tt>
<a name="L853"></a><tt class="py-lineno">853</tt>  <tt class="py-line">               <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ktrace</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-40" class="py-name"><a title="simvoc.core.kernel.Simulator.get_timestamp" class="py-name" href="#" onclick="return doclink('link-40', 'get_timestamp', 'link-32');">get_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">cur_time</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">,</tt> \ </tt>
<a name="L854"></a><tt class="py-lineno">854</tt>  <tt class="py-line">                             <tt class="py-name">cur_size</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt><tt class="py-op">,</tt> <tt class="py-name">rate</tt><tt class="py-op">,</tt> <tt class="py-name">total</tt><tt class="py-op">,</tt> <tt class="py-name">delta_q</tt><tt class="py-op">)</tt> </tt>
<a name="L855"></a><tt class="py-lineno">855</tt>  <tt class="py-line">               <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-41" class="py-name"><a title="simvoc.core.kernel.Simulator.add_result" class="py-name" href="#" onclick="return doclink('link-41', 'add_result', 'link-29');">add_result</a></tt><tt class="py-op">(</tt><tt class="py-name">t</tt><tt class="py-op">)</tt> </tt>
<a name="L856"></a><tt class="py-lineno">856</tt>  <tt class="py-line">         <tt class="py-comment">#</tt> </tt>
<a name="L857"></a><tt class="py-lineno">857</tt>  <tt class="py-line">         <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-42" class="py-name"><a title="simvoc.core.kernel.EventQueue.has_regular_events
simvoc.core.kernel.Simulator.has_regular_events" class="py-name" href="#" onclick="return doclink('link-42', 'has_regular_events', 'link-16');">has_regular_events</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L858"></a><tt class="py-lineno">858</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_cycle_count</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L859"></a><tt class="py-lineno">859</tt>  <tt class="py-line">         <tt class="py-keyword">elif</tt> <tt class="py-op">(</tt><tt class="py-keyword">not</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug</tt><tt class="py-op">)</tt> <tt class="py-keyword">and</tt> <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_thresh</tt> <tt class="py-op">&gt;</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
<a name="L860"></a><tt class="py-lineno">860</tt>  <tt class="py-line">            <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_cycle_count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L861"></a><tt class="py-lineno">861</tt>  <tt class="py-line">            <tt class="py-keyword">if</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_cycle_count</tt> <tt class="py-op">&gt;</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__debug_thresh</tt><tt class="py-op">:</tt> </tt>
<a name="L862"></a><tt class="py-lineno">862</tt>  <tt class="py-line">               <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-43" class="py-name" targets="Method simvoc.core.kernel.Simulator.debug_trigger()=simvoc.core.kernel.Simulator-class.html#debug_trigger"><a title="simvoc.core.kernel.Simulator.debug_trigger" class="py-name" href="#" onclick="return doclink('link-43', 'debug_trigger', 'link-43');">debug_trigger</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L863"></a><tt class="py-lineno">863</tt>  <tt class="py-line">      <tt class="py-name">end_time</tt> <tt class="py-op">=</tt> <tt class="py-name">time</tt><tt class="py-op">.</tt><tt class="py-name">time</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L864"></a><tt class="py-lineno">864</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__exec_time</tt> <tt class="py-op">=</tt> <tt class="py-name">end_time</tt> <tt class="py-op">-</tt> <tt class="py-name">start_time</tt> </tt>
<a name="L865"></a><tt class="py-lineno">865</tt>  <tt class="py-line">      <tt class="py-name">rate</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt> <tt class="py-op">/</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__exec_time</tt> </tt>
<a name="L866"></a><tt class="py-lineno">866</tt>  <tt class="py-line">      <tt class="py-name">m</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__kmeta</tt><tt class="py-op">(</tt><tt class="py-name">start_time</tt><tt class="py-op">,</tt> <tt class="py-name">end_time</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__exec_time</tt><tt class="py-op">,</tt> \ </tt>
<a name="L867"></a><tt class="py-lineno">867</tt>  <tt class="py-line">                       <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt><tt class="py-op">,</tt> <tt class="py-name">rate</tt><tt class="py-op">)</tt> </tt>
<a name="L868"></a><tt class="py-lineno">868</tt>  <tt class="py-line">      <tt class="py-name">t</tt> <tt class="py-op">=</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__ktrace</tt><tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-44" class="py-name"><a title="simvoc.core.kernel.Simulator.get_timestamp" class="py-name" href="#" onclick="return doclink('link-44', 'get_timestamp', 'link-32');">get_timestamp</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">end_time</tt><tt class="py-op">,</tt> <tt class="py-string">'end simulation'</tt><tt class="py-op">,</tt> \ </tt>
<a name="L869"></a><tt class="py-lineno">869</tt>  <tt class="py-line">                        <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-45" class="py-name"><a title="simvoc.core.kernel.Simulator.get_queue_size" class="py-name" href="#" onclick="return doclink('link-45', 'get_queue_size', 'link-27');">get_queue_size</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt><tt class="py-op">,</tt> <tt class="py-name">rate</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">0</tt><tt class="py-op">)</tt> </tt>
<a name="L870"></a><tt class="py-lineno">870</tt>  <tt class="py-line">      <tt class="py-name">self</tt><tt class="py-op">.</tt><tt id="link-46" class="py-name"><a title="simvoc.core.kernel.Simulator.add_result" class="py-name" href="#" onclick="return doclink('link-46', 'add_result', 'link-29');">add_result</a></tt><tt class="py-op">(</tt><tt class="py-op">(</tt><tt class="py-op">[</tt><tt class="py-name">m</tt><tt class="py-op">,</tt> <tt class="py-name">t</tt><tt class="py-op">]</tt><tt class="py-op">,</tt><tt class="py-op">)</tt><tt class="py-op">)</tt> </tt>
<a name="L871"></a><tt class="py-lineno">871</tt>  <tt class="py-line">      <tt class="py-keyword">print</tt> <tt class="py-op">&gt;&gt;</tt> <tt class="py-name">sys</tt><tt class="py-op">.</tt><tt class="py-name">stderr</tt><tt class="py-op">,</tt> \ </tt>
<a name="L872"></a><tt class="py-lineno">872</tt>  <tt class="py-line">         <tt class="py-string">'Processed %d events in %0.3f seconds (%d events/sec)'</tt> <tt class="py-op">%</tt> \ </tt>
<a name="L873"></a><tt class="py-lineno">873</tt>  <tt class="py-line">         <tt class="py-op">(</tt><tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__processed</tt><tt class="py-op">,</tt> <tt class="py-name">self</tt><tt class="py-op">.</tt><tt class="py-name">__exec_time</tt><tt class="py-op">,</tt> <tt class="py-name">rate</tt><tt class="py-op">)</tt> </tt>
</div></div><a name="L874"></a><tt class="py-lineno">874</tt>  <tt class="py-line">      <tt class="py-comment">#</tt> </tt>
<a name="L875"></a><tt class="py-lineno">875</tt>  <tt class="py-line">   <tt class="py-comment">#</tt> </tt>
<a name="L876"></a><tt class="py-lineno">876</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L877"></a><tt class="py-lineno">877</tt>  <tt class="py-line"> </tt>
<a name="L878"></a><tt class="py-lineno">878</tt>  <tt class="py-line"><tt class="py-keyword">if</tt> <tt class="py-name">__name__</tt> <tt class="py-op">==</tt> <tt class="py-string">'__main__'</tt><tt class="py-op">:</tt> </tt>
<a name="timefn"></a><div id="timefn-def"><a name="L879"></a><tt class="py-lineno">879</tt> <a class="py-toggle" href="#" id="timefn-toggle" onclick="return toggle('timefn');">-</a><tt class="py-line">   <tt class="py-keyword">def</tt> <a class="py-def-name" href="simvoc.core.kernel-module.html#timefn">timefn</a><tt class="py-op">(</tt><tt class="py-param">xtime</tt><tt class="py-op">,</tt> <tt class="py-param">simobj</tt><tt class="py-op">,</tt> <tt class="py-param">msg</tt><tt class="py-op">=</tt><tt class="py-string">''</tt><tt class="py-op">)</tt><tt class="py-op">:</tt> </tt>
</div><div id="timefn-collapsed" style="display:none;" pad="+++" indent="+++++++"></div><div id="timefn-expanded"><a name="L880"></a><tt class="py-lineno">880</tt>  <tt class="py-line">      <tt class="py-keyword">return</tt> <tt class="py-op">(</tt><tt class="py-name">str</tt><tt class="py-op">(</tt><tt class="py-name">xtime</tt><tt class="py-op">)</tt> <tt class="py-op">+</tt> <tt class="py-string">' '</tt> <tt class="py-op">+</tt> <tt class="py-name">msg</tt><tt class="py-op">)</tt><tt class="py-op">.</tt><tt class="py-name">strip</tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
</div><a name="L881"></a><tt class="py-lineno">881</tt>  <tt class="py-line">   <tt class="py-name">count</tt> <tt class="py-op">=</tt> <tt class="py-number">0</tt> </tt>
<a name="L882"></a><tt class="py-lineno">882</tt>  <tt class="py-line">   <tt class="py-name">sim</tt> <tt class="py-op">=</tt> <tt id="link-47" class="py-name" targets="Class simvoc.core.kernel.Simulator=simvoc.core.kernel.Simulator-class.html"><a title="simvoc.core.kernel.Simulator" class="py-name" href="#" onclick="return doclink('link-47', 'Simulator', 'link-47');">Simulator</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L883"></a><tt class="py-lineno">883</tt>  <tt class="py-line">   <tt class="py-name">total</tt> <tt class="py-op">=</tt> <tt class="py-name">sim</tt><tt class="py-op">.</tt><tt class="py-name">random</tt><tt class="py-op">.</tt><tt class="py-name">randint</tt><tt class="py-op">(</tt><tt class="py-number">15</tt><tt class="py-op">,</tt> <tt class="py-number">30</tt><tt class="py-op">)</tt> </tt>
<a name="L884"></a><tt class="py-lineno">884</tt>  <tt class="py-line">   <tt class="py-keyword">while</tt> <tt class="py-name">count</tt> <tt class="py-op">&lt;</tt> <tt class="py-name">total</tt><tt class="py-op">:</tt> </tt>
<a name="L885"></a><tt class="py-lineno">885</tt>  <tt class="py-line">      <tt class="py-name">xtime</tt> <tt class="py-op">=</tt> <tt class="py-name">sim</tt><tt class="py-op">.</tt><tt class="py-name">random</tt><tt class="py-op">.</tt><tt class="py-name">randint</tt><tt class="py-op">(</tt><tt class="py-number">0</tt><tt class="py-op">,</tt> <tt class="py-number">10000</tt><tt class="py-op">)</tt> </tt>
<a name="L886"></a><tt class="py-lineno">886</tt>  <tt class="py-line">      <tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-48" class="py-name" targets="Method simvoc.core.kernel.EventQueue.new_simple_event()=simvoc.core.kernel.EventQueue-class.html#new_simple_event,Method simvoc.core.kernel.Simulator.new_simple_event()=simvoc.core.kernel.Simulator-class.html#new_simple_event"><a title="simvoc.core.kernel.EventQueue.new_simple_event
simvoc.core.kernel.Simulator.new_simple_event" class="py-name" href="#" onclick="return doclink('link-48', 'new_simple_event', 'link-48');">new_simple_event</a></tt><tt class="py-op">(</tt><tt class="py-name">xtime</tt><tt class="py-op">,</tt> <tt class="py-name">timefn</tt><tt class="py-op">,</tt> <tt class="py-name">msg</tt><tt class="py-op">=</tt><tt class="py-string">'hi'</tt><tt class="py-op">)</tt> </tt>
<a name="L887"></a><tt class="py-lineno">887</tt>  <tt class="py-line">      <tt class="py-name">count</tt> <tt class="py-op">+=</tt> <tt class="py-number">1</tt> </tt>
<a name="L888"></a><tt class="py-lineno">888</tt>  <tt class="py-line">   <tt class="py-name">sim</tt><tt class="py-op">.</tt><tt id="link-49" class="py-name" targets="Method simvoc.core.kernel.Simulator.run()=simvoc.core.kernel.Simulator-class.html#run,Method simvoc.core.voc_sim.VMPilot.run()=simvoc.core.voc_sim.VMPilot-class.html#run"><a title="simvoc.core.kernel.Simulator.run
simvoc.core.voc_sim.VMPilot.run" class="py-name" href="#" onclick="return doclink('link-49', 'run', 'link-49');">run</a></tt><tt class="py-op">(</tt><tt class="py-op">)</tt> </tt>
<a name="L889"></a><tt class="py-lineno">889</tt>  <tt class="py-line"><tt class="py-comment">#</tt> </tt>
<a name="L890"></a><tt class="py-lineno">890</tt>  <tt class="py-line"> </tt><script type="text/javascript">
<!--
expandto(location.href);
// -->
</script>
</pre>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="simvoc-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >SimVOC</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0 on Fri Oct 23 11:04:37 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
